Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #104

Merged
merged 2 commits into from
Apr 4, 2024
Merged

Update README.md #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f2d4f0
Update README.md
quetzaluz Mar 27, 2024
53aa7ef
Merge branch 'master' into patch-1
ssaunier Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Wait On Check Action

[![StandardRB](https://github.com/lewagon/wait-on-check-action/actions/workflows/standardrb-linter.yml/badge.svg)](https://github.com/lewagon/wait-on-check-action/actions/workflows/standardrb-linter.yml)
[![RSpec tests](https://github.com/lewagon/wait-on-check-action/actions/workflows/run-tests.yml/badge.svg)](https://github.com/lewagon/wait-on-check-action/actions/workflows/run-tests.yml)

Pause a workflow until a job in another workflow completes successfully.

This action uses the [Checks API][checks_api] to poll for check results. On success, the action exit allowing the workflow resume. Otherwise, the action will exit with status code 1 and fail the whole workflow.
This action uses the [Checks API](https://docs.github.com/en/rest/checks) to poll for check results. On success, the action exit allowing the workflow resume. Otherwise, the action will exit with status code 1 and fail the whole workflow.

This is a workaround to GitHub's limitation of non-interdependent workflows :tada:

Expand Down Expand Up @@ -122,7 +125,7 @@ jobs:
name: Deploy a new image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Wait for tests to succeed
uses: lewagon/wait-on-check-action@v1.3.4
Expand Down Expand Up @@ -290,7 +293,7 @@ jobs:
- uses: actions/checkout@v2

- name: Wait on tests
uses: ./
uses: lewagon/wait-on-check-action@v1.3.3
with:
ref: ${{ github.sha }}
repo-token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -312,7 +315,7 @@ jobs:
- uses: actions/checkout@v2

- name: Wait on tests
uses: ./
uses: lewagon/wait-on-check-action@v1.3.3
with:
ref: ${{ github.sha }}
repo-token: ${{ secrets.GITHUB_TOKEN }}
Expand Down