https://github.com/int128/wait-for-deployment-action
Action to wait for GitHub Deployments of current commit
https://github.com/int128/wait-for-deployment-action
deployment github-actions
Last synced: 12 days ago
JSON representation
Action to wait for GitHub Deployments of current commit
- Host: GitHub
- URL: https://github.com/int128/wait-for-deployment-action
- Owner: int128
- License: apache-2.0
- Created: 2022-09-22T07:48:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T22:37:58.000Z (13 days ago)
- Last Synced: 2025-07-01T23:32:01.367Z (13 days ago)
- Topics: deployment, github-actions
- Language: TypeScript
- Homepage:
- Size: 9.68 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wait-for-deployment-action [](https://github.com/int128/wait-for-deployment-action/actions/workflows/ts.yaml)
This is an action to wait for the GitHub Deployment.
## Getting Started
To create a comment when all deployments are succeeded,
```yaml
name: wait-for-deployment-succeeded
on:
pull_request:
jobs:
notify:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: int128/wait-for-deployment-action@v1
id: deployment
with:
until: succeeded
deployment-sha: ${{ github.event.pull_request.head.sha || github.sha }}
- uses: int128/comment-action@v1
with:
post: |
## Deployed successfully
${{ steps.deployment.outputs.summary }}
```
To create a comment when all deployments are completed or timed out,
```yaml
name: wait-for-deployment-succeeded
on:
pull_request:
jobs:
notify:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: int128/wait-for-deployment-action@v1
id: deployment
with:
timeout-seconds: 300
until: completed
deployment-sha: ${{ github.event.pull_request.head.sha || github.sha }}
- if: steps.deployment.outputs.succeeded == 'true'
uses: int128/comment-action@v1
with:
post: |
## :white_check_mark: Deployed successfully
${{ steps.deployment.outputs.summary }}
- if: steps.deployment.outputs.progressing == 'true'
uses: int128/comment-action@v1
with:
post: |
## :construction: Deployment is in progress
${{ steps.deployment.outputs.summary }}
- if: steps.deployment.outputs.failed == 'true'
uses: int128/comment-action@v1
with:
post: |
## :x: Deployment failed
${{ steps.deployment.outputs.summary }}
```
### Wait for the condition
If `until` is set to `succeeded`,
- When **all** deployments are succeeded, this action exits successfully.
- When **any** deployment is failed, this action exits with an error.
If `until` is set to `completed`,
- When **all** deployments are completed, this action exits successfully.
### Set a timeout
If `timeout-seconds` is set, this action stops after the timeout.
This action determines the exit code based on the condition at the timeout.
## Specification
### Inputs
| Name | Default | Description |
| ----------------------- | -------------- | ------------------------------------------- |
| `filter-environments` | - | Filter deployments by environment patterns |
| `exclude-environments` | - | Exclude deployments by environment patterns |
| `until` | (required) | Either `completed` or `succeeded` |
| `initial-delay-seconds` | 10 | Initial delay before polling in seconds |
| `period-seconds` | 15 | Polling interval in seconds |
| `timeout-seconds` | - | If set, poll until the timeout |
| `deployment-sha` | (required) | Find the deployments of the commit |
| `token` | `github.token` | GitHub token |
### Outputs
| Name | Description |
| ------------- | ----------------------------------------- |
| `completed` | Whether **all** deployments are completed |
| `succeeded` | Whether **all** deployments are succeeded |
| `progressing` | Whether **any** deployment is progressing |
| `failed` | Whether **any** deployment is failed |
| `summary` | Markdown list of all deployments |
| `json` | JSON representation of all deployments |
This action determines the outputs as below table.
| GitHub deployment state | Completed | Succeeded | Progressing | Failed |
| ----------------------- | --------- | --------- | ----------- | ------ |
| QUEUED | - | - | x | - |
| IN_PROGRESS | - | - | x | - |
| ACTIVE | x | x | - | - |
| SUCCESS | x | x | - | - |
| FAILURE | x | - | - | x |
| ERROR | x | - | - | x |
| (others) | - | - | - | - |
x: This action maps the state of GitHub deployment to the corresponding column.
#### `json` output
Here is an example of the `json` output.
```json
{
"deployments": [
{
"environment": "pr-1",
"state": "ACTIVE",
"url": "https://argocd.example.com/pr-1"
}
]
}
```
See [deployments.ts](deployments.ts) for the type definition.