Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
Signed-off-by: Gavin Didrichsen <[email protected]>
  • Loading branch information
gavindidrichsen committed Oct 21, 2024
1 parent 216f6a6 commit 3303413
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/workflow-restarter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@ Nevertheless, it is possible to programmatically restart a workflow after it fai

If setting up the the `workflow-restarter` for the first time, then make sure to initialize it first and then configure another workflow to programmatically restart on failure. In other words, you need to create 2 PRs

* Create one PR that only adds the `.github/workflows/{workflow-restarter.yml,workflow-restarter-test.yml}` files. For the `workflow-restarter` to work, it must be merged into the main branch before it can be referenced by other workflows (this seems to be a github action feature). Once this PR has been merged into the `main` branch then kick-off the `workflow-restarter-test`. Only if this works as expected, then
* Create a second PR to add the `on-failure-workflow-restarter-proxy` to existing workflows.

For more information regarding the above, read the next couple sections.
* Create one PR that only adds the `.github/workflows/{workflow-restarter.yml,workflow-restarter-test.yml}` files. See [Create the first PR...](#create-the-first-pr-to-initialize-the-workflow-restarter) section below.
* Create a second PR to add the `on-failure-workflow-restarter-proxy` to existing workflows. See [Create the second PR...](#create-the-second-pr-to-re-use-it-in-other-workflows) section below.

### Create the first PR to initialize the `Workflow Restarter`

In order to begin using the workflow-restarter, you need to first raise a PR and add the workflow restarter to your target repository. In other words,
In order to begin using the workflow-restarter, you need to first raise a PR and add the workflow restarter to your target repository. In other words, for the `workflow-restarter` to work, it must be merged into the `main` branch before it can be referenced by other workflows (this seems to be a github action feature).

* Copy [workflow-restarter.yml](./workflow-restarter/workflow-restarter.yml) and [workflow-restarter-test.yml](./workflow-restarter/workflow-restarter-test.yml) to the `.github/workflows` directory of your target directory.
* Raise and merge a PR adding the above to the main branch of your repository.
Expand Down

0 comments on commit 3303413

Please sign in to comment.