Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomchv/wait-my-workflow
The objective of this action is to wait the end of a workflow
https://github.com/tomchv/wait-my-workflow
github-actions workflow-management
Last synced: 3 months ago
JSON representation
The objective of this action is to wait the end of a workflow
- Host: GitHub
- URL: https://github.com/tomchv/wait-my-workflow
- Owner: TomChv
- License: mit
- Created: 2020-07-29T15:21:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-12T09:26:12.000Z (over 1 year ago)
- Last Synced: 2024-10-18T00:41:48.007Z (4 months ago)
- Topics: github-actions, workflow-management
- Language: TypeScript
- Homepage:
- Size: 780 KB
- Stars: 13
- Watchers: 1
- Forks: 4
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Action : Wait my workflow
This github action is based on [wait-for-check](https://github.com/fountainhead/action-wait-for-check) action, please go put a star on his repo if you like my action. I simply altered the actions to match my needs.
It works thanks to the [check states](https://docs.github.com/en/rest/reference/checks) (github action jobs). The action will ping the github API and check if a job is running on the repo given as argument.
The objective of this action is to allow chained workflows. If the expected workflow doesn't run / exist, the action just stops waiting in order to don't lose time.
The timeout starts when the job is starting and not when it is in a queue. This ensures that you do not have a timeout for nothing.
**Tips**: be sure all yours jobs has a unique name in order to don't have surprise.
**Tips**: Remember that you can also wait multiples steps. Simply wait for each step as you go along (if the step is already completed, the conclusion remains intact).
## Example
Let's imagine a scenario where you have to wait for a build to finish before launching your deployment workflow.
Your workflows files should look like this :
**Build workflow**
```yaml
name: Build my app
on:
push:
jobs:
build: # Here is your checkName var
runs-on: self-hosted
steps:
## Build you application.. Push it to docker for example
```
> Your build step can also be in the deployment file. It's just a step.
**Deployment workflow**
On this workflow, 4 conditions can be triggered depending on the progress of the build(s)
```yaml
name: Deploy my app
on:
push:
jobs:
deploy:
steps:
- name: Wait my build
uses: tomchv/[email protected]
id: wait-build
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: build
ref: ${{ github.event.pull_request.head.sha || github.sha }}
intervalSeconds: 10
timeoutSeconds: 100
- name: Do something if build success
if: steps.wait-build.outputs.conclusion == 'success'
run: echo success && true # You can also just continue with
- name: Do something if build isn't launch
if: steps.wait-build.outputs.conclusion == 'does not exist'
run: echo job does not exist && true
- name: Do something if build fail
if: steps.wait-build.outputs.conclusion == 'failure'
run: echo fail && false # fail if build fail
- name: Do something if build timeout
if: steps.wait-build.outputs.conclusion == 'timed_out'
run: echo Timeout && false # fail if build time out
- name: Deploy my add
# Deploy my app... or wait an other build
```
## Inputs
This Action accepts the following configuration parameters via `with:`
- `token`
**Required**
The GitHub token to use for making API requests. Typically, this would be set to `${{ secrets.GITHUB_TOKEN }}`.
- `checkName`
**Required**
The name of the GitHub check to wait for. For example, `build` or `deploy`.
- `ref`
**Default: `github.sha`**
The Git ref of the commit you want to poll for a passing check.
*PROTIP: You may want to use `github.pull_request.head.sha` when working with Pull Requests.*
- `repo`
**Default: `github.repo.repo`**
The name of the Repository you want to poll for a passing check.
- `owner`
**Default: `github.repo.owner`**
The name of the Repository's owner you want to poll for a passing check.
- `timeoutSeconds`
**Default: `600`**
The number of seconds to wait for the check to complete. If the check does not complete within this amount of time, this Action will emit a `conclusion` value of `timed_out`.
- `intervalSeconds`
**Default: `10`**
The number of seconds to wait before each poll of the GitHub API for checks on this commit.
## Outputs
This Action emits a single output named `conclusion`. Like the field of the same name in the [CheckRunEvent API Response](https://developer.github.com/v3/activity/events/types/#checkrunevent-api-payload), it may be one of the following values:
- `success`
- `failure`
- `neutral`
- `timed_out`
- `action_required`
These correspond to the `conclusion` state of the Check you're waiting on. In addition, this action will emit a conclusion of `timed_out` if the Check specified didn't complete within `timeoutSeconds`.
If the job does not exist, this Action will emit `not found` as conclusion.