https://github.com/kachick/wait-other-jobs
⏳ Wait other jobs/workflows☕
https://github.com/kachick/wait-other-jobs
auto-merge dependabot github-actions wait
Last synced: 7 months ago
JSON representation
⏳ Wait other jobs/workflows☕
- Host: GitHub
- URL: https://github.com/kachick/wait-other-jobs
- Owner: kachick
- License: mit
- Created: 2022-05-27T12:27:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T23:02:43.000Z (7 months ago)
- Last Synced: 2025-03-25T02:51:31.691Z (7 months ago)
- Topics: auto-merge, dependabot, github-actions, wait
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/wait-other-jobs
- Size: 5.45 MB
- Stars: 9
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# wait-other-jobs
[](https://github.com/kachick/wait-other-jobs/actions/workflows/itself.yml?query=branch%3Amain)\
[](https://github.com/kachick/wait-other-jobs/actions/workflows/GH-820-graceperiod.yml?query=branch%3Amain)
[](https://github.com/kachick/wait-other-jobs/actions/workflows/GH-771-eventname.yml?query=branch%3Amain)
[](https://github.com/kachick/wait-other-jobs/actions/workflows/GH-761-matrix.yml?query=branch%3Amain)\
[](https://github.com/kachick/wait-other-jobs/actions/workflows/ci.yml?query=branch%3Amain)
This GitHub action waits for all or specific jobs, even if they are running in other workflows.\
If any of those jobs fail, this action will fail as well.
## Usage
Zero or tiny configuration may work.
```yaml
jobs:
your_job:
# Enabling these permissions are required in private repositories
# permissions:
# contents: read
# checks: read
# actions: read
runs-on: ubuntu-24.04
steps:
- uses: kachick/wait-other-jobs@v3.8.0
timeout-minutes: 15 # Recommended to be enabled with your appropriate value for fail-safe use
```
You can change the token, polling interval, allow/deny list and turns early-exit as below.
```yaml
with:
warmup-delay: 'PT30S' # default 'PT10S'
minimum-interval: 'PT300S' # default 'PT15S'
retry-method: 'exponential_backoff' # default 'equal_intervals'
early-exit: 'false' # default 'true'
skip-same-workflow: 'true' # default 'false'
wait-list: |
[
{
"workflowFile": "ci.yml",
"jobName": "test",
"eventName": "${{ github.event_name }}"
},
{
"workflowFile": "release.yml",
"optional": true
}
]
skip-list: |
[
{
"workflowFile": "pages.yml"
}
]
```
Full list of the options
| NAME | DESCRIPTION | TYPE | DEFAULT | OPTIONS |
| -------------------- | ------------------------------------------------------------------------------- | -------- | ----------------------- | --------------------------------------------------------------- |
| `github-api-url` | The Github API endpoint. Override for Github Enterprise usage. | `string` | `${{ github.api_url }}` | `https://api.github.com`, `https://ghe-host.example.net/api/v3` |
| `github-token` | The GITHUB_TOKEN secret. You can use PAT if you want. | `string` | `${{ github.token }}` | |
| `warmup-delay` | Wait this interval before first polling | `string` | `PT10S` | ISO 8601 duration format |
| `minimum-interval` | Wait for this or a longer interval between each poll to reduce GitHub API calls | `string` | `PT15S` | ISO 8601 duration format |
| `retry-method` | How to wait for next polling | `string` | `equal_intervals` | `exponential_backoff`, `equal_intervals` |
| `early-exit` | Stop rest pollings if faced at least 1 bad condition | `bool` | `true` | |
| `attempt-limits` | Stop rest pollings if reached to this limit | `number` | `1000` | |
| `wait-list` | Wait only these jobs | `string` | `[]` | JSON Array |
| `skip-list` | Wait except these jobs | `string` | `[]` | JSON Array |
| `skip-same-workflow` | Skip jobs defined in the same workflow which using this action | `bool` | `false` | |
| `dry-run` | Avoid requests for tests | `bool` | `false` | |
## Guide for option syntax and reasonable values
- [ISO 8601 duration format](https://github.com/tc39/proposal-temporal/blob/0.9.0/docs/duration.md)
- [Trailing commas are not allowed in JSON](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Trailing_commas)
- GitHub API Limit: At least we should consider about `GITHUB_TOKEN`, that is allowed 1000 per hour per repository.\
Roughly calculating for long jobs, setting the `minimum-interval` larger than or equal `PT4S` would be safer.
- [Primary Limit](https://github.com/github/docs/blob/5c2caf1b693a557043b49dabe5115177e666fca9/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md?plain=1#L78)
- [Secondary Limit](https://github.com/github/docs/blob/5c2caf1b693a557043b49dabe5115177e666fca9/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md)
## Schema of wait-list and skip-list
Lists should be given with JSON array, do not use both wait-list and skip-list together
- Each item should have a "workflowFile" field, and they can optionally have a "jobName" field.
- If no jobName is specified, all the jobs in the workflow will be targeted.
- wait-list:
- If the checkRun for the specified name is not found, this action raise errors by default.\
You can disable this validation with `"optional": true` or use the `startupGracePeriod` that described in following section
- Wait for all event types by default, you can change with `"eventName": "EVENT_NAME_AS_push"`.
## Required GITHUB_TOKEN permissions
In public repositories, they are satisfied by default
```yaml
permissions:
contents: read # Since v2
checks: read
actions: read
```
## Support for Github Enterprise
To run this action in your Github Enterprise (GHE) instance you need to override `github-api-url`:
```yaml
with:
github-api-url: 'https://ghe-host.example.net/api/v3'
```
## outputs.
- `parameters`\
Parsed values from `with` and some context.\
This data is only provided for testing, so the schema is not defined.
- `dump`\
A file path for collected resources which keeps fields than logged.\
This data is only provided for debugging, so the schema is not defined.
## Examples
I'm using this action for auto-merging bot PRs and wait for deploy.\
See the [docs](docs/examples.md) for further detail.
## Deadlocks
If you use this action in multiple jobs on the same repository, you should avoid deadlocks.\
The `skip-list`, `wait-list` and `skip-same-workflow` options cover this use case.
If you changed job name from the default, you should set `skip-list` or roughly use `skip-same-workflow`
```yaml
jobs:
your_job: # This will be used default job name if you not specify below "name" field
name: 'Changed at here'
runs-on: ubuntu-24.04
steps:
- uses: kachick/wait-other-jobs@v3.8.0
with:
skip-list: |
[
{
"workflowFile": "this_file_name.yml",
"jobName": "Changed at here"
}
]
timeout-minutes: 15
```
Similar problems should be considered in matrix use. Because of GitHub does not provide the context.
- https://github.com/orgs/community/discussions/8945
- https://github.com/orgs/community/discussions/16614
However you can set `prefix` for `jobMatchMode` to create small skip-list to avoid this problem.
```yaml
jobs:
your_job:
strategy:
matrix:
os:
- ubuntu-24.04
- ubuntu-22.04
runs-on: ${{ matrix.os }}
steps:
- uses: kachick/wait-other-jobs@v3.8.0
with:
skip-list: |
[
{
"workflowFile": "this_file_name.yml",
"jobMatchMode": "prefix",
"jobName": "${{ github.job }}"
}
]
- run: make test
```
## Startup grace period
Judge whether the checkRun state at the moment.\
When some jobs are triggered late after this action, we need to use the following configurations.
An example of using a `wait-list`.
```yaml
with:
wait-list: |
[
{
"workflowFile": "might_be_triggered_after_0-4_minutes.yml",
"optional": false,
"startupGracePeriod": { "minutes": 5 }
}
]
```
This action starts immediately but ignores the job missing in the first 5 minutes.
- No need to extend `warmup-delay`
- Disable `optional`, because it is needed to check
- Set enough value for `startupGracePeriod` for this purpose.\
It should be parsible with [TC39 - Temporal.Duration](https://github.com/tc39/proposal-temporal/blob/26e4cebe3c49f56932c1d5064fec9993e981823a/docs/duration.md)\
e.g
- `"PT3M42S"` # ISO 8601 duration format
- `{ "minutes": 3, "seconds": 42 }` # key-value for each unit
If not using wait-list, this pattern should be considered in your `warmup-delay`.
## Alternative candidates
[gh](https://github.com/cli/cli) commands, such as `gh pr checks` and `gh run watch`, should be useful if your requirements are simple.
## Limitations
- If any workflow starts many jobs as 100+, this action does not support it.\
Because of nested paging in GraphQL makes complex. See [related docs](https://github.com/octokit/plugin-paginate-graphql.js/blob/a6b12e867466b0c583b002acd1cb1ed90b11841f/README.md?plain=1#L184-L218) for further detail.
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)