Skip to content

Commit 0025356

Browse files
Merge pull request #117 from puppetlabs/update_doc
Fix workflow-restarter instructions to contain "@main"
2 parents 96866b0 + b1ea765 commit 0025356

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/workflow-restarter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ In order to begin using the workflow-restarter, you need to first raise a PR and
2121
Once the above `Workflow Restarter TEST` is working then you should be able to add the workflow restarter to any of your existing github workflows. The key is to re-use the `on-failure-workflow-restarter-proxy` located in the `Workflow Restarter TEST`. For example, the following will trigger a restart if either the `acceptance` or the `unit` jobs preceeding it fail. A restart of the failing jobs will be attempted 3 times at which point if the failing jobs continue to fail, then the workflow will be marked as failed. If, however, at any point the `acceptance` and `unit` both pass fine then the restarted workflow will be marked as successful
2222

2323
```yaml
24-
on-failure-workflow-restarter-proxy:
24+
on-failure-workflow-restarter-proxy:
2525
# (1) run this job after the "acceptance" job and...
2626
needs: [acceptance, unit]
2727
# (2) continue ONLY IF "acceptance" fails
@@ -32,14 +32,14 @@ Once the above `Workflow Restarter TEST` is working then you should be able to a
3232
- name: Checkout repository
3333
uses: actions/checkout@v4
3434

35+
# (4) "use" the custom action to retrigger the failed "acceptance job" above
3536
- name: Trigger reusable workflow
36-
uses: "puppetlabs/cat-github-actions/.github/actions/workflow-restarter-proxy"
37+
uses: "puppetlabs/cat-github-actions/.github/actions/workflow-restarter-proxy@main"
3738
env:
3839
SOURCE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3940
with:
4041
repository: ${{ github.repository }}
4142
run_id: ${{ github.run_id }}
42-
4343
```
4444
4545
## Appendix

0 commit comments

Comments
 (0)