Skip to content

Commit

Permalink
Update README.md (#104)
Browse files Browse the repository at this point in the history
Update README link placeholders and versioning

Co-authored-by: Sébastien Saunier <seb@saunier.me>
  • Loading branch information
quetzaluz and ssaunier authored Apr 4, 2024
1 parent 50d2136 commit d538c08
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
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

0 comments on commit d538c08

Please sign in to comment.