actions/wait-for-workflow-action
1
0
Fork 0
mirror of https://github.com/kamilchodola/wait-for-workflow-action.git synced 2026-04-30 16:17:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kamil Chodoła
2023-04-26 20:38:37 +02:00
committed by GitHub
parent 65a56ad675
commit 64b956687d
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -11,7 +11,9 @@ This GitHub Action waits for a specified workflow to complete before proceeding
| `GITHUB_TOKEN` | GitHub token to access the repository and its APIs | Yes | | | `GITHUB_TOKEN` | GitHub token to access the repository and its APIs | Yes | |
| `workflow_id` | ID of the workflow to wait for | No | | | `workflow_id` | ID of the workflow to wait for | No | |
| `run_id` | If provided will wait for workflow run with specified id | No | | | `run_id` | If provided will wait for workflow run with specified id | No | |
| `max_wait_minutes`| Maximum wait time in minutes before giving up | No | 5 | | `max_wait_minutes`| Maximum time script will wait to workflow run to be found in minutes | No | 5 |
| `interval`| Interval in seconds which will be used for GitHub API calls | No | 10 |
| `timeouts`| Maximum time script will wait to workflow run to be finished | No | 30 |
| `organization` | Organization name where the repository is located | Yes | | | `organization` | Organization name where the repository is located | Yes | |
| `repository` | Repository name to monitor for the workflow run | Yes | | | `repository` | Repository name to monitor for the workflow run | Yes | |
| `ref` | Branch reference to watch for the workflow run | No | | | `ref` | Branch reference to watch for the workflow run | No | |
@@ -46,6 +48,8 @@ To use this action, add it to your workflow file with the appropriate inputs:
GITHUB_TOKEN: ${{ secrets.REPOSITORY_DISPATCH_TOKEN }} GITHUB_TOKEN: ${{ secrets.REPOSITORY_DISPATCH_TOKEN }}
workflow_id: 'workflow_name.yml' workflow_id: 'workflow_name.yml'
max_wait_minutes: '3' max_wait_minutes: '3'
interval: '5'
timeout: '60'
organization: 'your-organization' organization: 'your-organization'
repository: 'your-repository' repository: 'your-repository'
ref: ${{ github.ref }} ref: ${{ github.ref }}