Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxgfr/github-multi-deployments
Github action which lets you to handle deployments status with multiple environments
https://github.com/maxgfr/github-multi-deployments
deployments github github-actions multi-deployments typescript
Last synced: 7 days ago
JSON representation
Github action which lets you to handle deployments status with multiple environments
- Host: GitHub
- URL: https://github.com/maxgfr/github-multi-deployments
- Owner: maxgfr
- License: mit
- Created: 2022-03-11T17:36:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T17:29:23.000Z (15 days ago)
- Last Synced: 2024-10-29T17:30:39.977Z (15 days ago)
- Topics: deployments, github, github-actions, multi-deployments, typescript
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/github-multi-deployments
- Size: 522 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Multi Deployments [](https://github.com/marketplace/actions/github-multi-deployments) [](https://github.com/maxgfr/github-multi-deployments/actions/workflows/test-build.yml)
`maxgfr/github-multi-deployments` is a [GitHub Action](https://github.com/features/actions) which enables you to deploy multiple environments in a single workflow.
This action is a fork of [`bobheadxi/deployments`](https://github.com/marketplace/actions/github-deployments). Thus, before dig into this action, you may check [bobheadxi documentation](https://github.com/bobheadxi/deployments).
## Usage
### Simple multi-deployment
```yml
on:
push:
branches:
- main
jobs:
action:
runs-on: ubuntu-latest
steps:
...
- name: Notify deployment start
uses: maxgfr/[email protected]
id: deployment
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
desc: 'Deploying environment C and environment D'
env: '["envC", "envD"]' # you can also use url as environment such as '["https://...."]'
debug: true
...
- name: Notify deployment finish
uses: maxgfr/[email protected]
with:
step: finish
status: 'success'
token: ${{ secrets.GITHUB_TOKEN }}
deployment_id: ${{ steps.deployment.outputs.deployment_id }}
# env_url: '["https://...."]' to bind the environments url to the deployment ids
debug: true
```
### Simple multi-deployment with environment deactivation
```yml
on:
push:
branches:
- main
jobs:
action:
runs-on: ubuntu-latest
steps:
...
- name: Notify deployment start
uses: maxgfr/[email protected]
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
desc: 'Deploying environment A and environment B'
env: '["envA", "envB"]'
debug: true
...
- name: Notify deployment deactivation
uses: maxgfr/[email protected]
with:
step: deactivate-env
token: ${{ secrets.GITHUB_TOKEN }}
env: '["envA", "envB"]'
debug: true
```
### Simple multi-deployment with environment destruction
```yml
on:
push:
branches:
- main
jobs:
action:
runs-on: ubuntu-latest
steps:
...
- name: Notify deployment start
uses: maxgfr/[email protected]
with:
step: start
token: ${{ secrets.GITHUB_TOKEN }}
desc: 'Deploying environment A and environment B'
env: '["envA", "envB"]'
debug: true
...
- name: Notify deployment delete
uses: maxgfr/[email protected]
with:
step: delete-env
token: ${{ secrets.GH_PAT_TOKEN }} # You muse use a personal access token with repo scope enabled
env: '["envA", "envB"]'
debug: true
```
### Get environment for a ref
```yml
on:
push:
branches:
- main
jobs:
action:
runs-on: ubuntu-latest
steps:
...
- name: Get a list of environments
uses: maxgfr/[email protected]
id: envs
with:
step: get-env
token: ${{ secrets.GITHUB_TOKEN }}
# ref: ${{ github.ref }} # You can also use ref to get the environment
debug: true
```
## Inputs
**Name**|**Type**|**Required**|**Description**
-----|-----|-----|-----
token|string|yes|GitHub token. You must use a personal access token with repo scope enabled if you want to use `delete-env`
step|string|yes|Key of the step to execute. Possible values are `start`, `deactivate-env`, `delete-env`, `finish`.
desc|string|no|Description to set in status.
ref|string|no|The git ref to use for the deploy, defaults to `GITHUB_REF` or `GITHUB_HEAD_REF`
repository|string|no|Set status for a different repository, using the format `$owner/$repository` (optional, defaults to the current repository)
env|string[] or string|no|Name of deployment(s) environment for Github. (Required for `start`, `deactivate-env` and `delete-env`)
deployment_id|string[] or string|no|Deployment(s) id(s) to update (if specified during `start`, the deployment will be updated instead of a new one created)
env_url|string[] or string|no|Environment(s) url (For `finish` only)
status|string|no|Status of the deployment (For `finish` only)
debug|boolean|no|Debug mode