Skip to content

Commit

Permalink
Update cancellation-docs (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
fkirc authored Mar 18, 2021
1 parent 4c656bb commit fda4aba
Showing 1 changed file with 1 addition and 10 deletions.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Instead of blindly skipping checks, the backtracking-algorithm will only skip so
## Cancel outdated workflow-runs

Typically, workflows should only run for the most recent commit.
Therefore, when you push changes to a branch, `skip-duplicate-actions` will cancel any previous workflow-runs that run against outdated commits.
Therefore, when you push changes to a branch, `skip-duplicate-actions` can be configured to cancel any previous workflow-runs that run against outdated commits.

- **Full traceability:** If a workflow-run is cancelled, then you will see a message like `Cancelled <previous_run_URL>`.
- **Guaranteed execution:** The cancellation-algorithm guarantees that a complete check-set will finish no matter what.
Expand Down Expand Up @@ -161,15 +161,6 @@ jobs:
echo "Do other stuff..."
```

### Option 3: Cancellation-only

If you do not care about the skip-features, then you can simply ignore the `should_skip`-output.
In this case, the integration reduces to the following:

```yml
- uses: fkirc/skip-duplicate-actions@master
```

## How does it work?

`skip-duplicate-actions` uses the [Workflow Runs API](https://docs.github.com/en/rest/reference/actions#workflow-runs) to query workflow-runs.
Expand Down

0 comments on commit fda4aba

Please sign in to comment.