Skip to content

Commit

Permalink
chore(docs): document the native behavior (#201)
Browse files Browse the repository at this point in the history
So long, and thanks for all the
fish<sup>[1](https://en.wikipedia.org/wiki/So_Long,_and_Thanks_for_All_the_Fish)</sup>

- Related to #200 
- Closes #191 
- Closes #76
  • Loading branch information
styfle committed Jan 13, 2023
1 parent a0540e0 commit 3b7e3bd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
> **Warning**
> In April 2021, GitHub [announced](https://github.blog/changelog/2021-04-19-github-actions-limit-workflow-run-or-job-concurrency/) native support for canceling workflows.
>
> You probably don't need this custom action. Instead, use the native behavior by adding this to your workflow yaml:
> ```
> concurrency:
> group: ${{ github.workflow }}-${{ github.ref }}
> cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
> ```
> Read the [official documentation](https://docs.github.com/en/actions/using-jobs/using-concurrency) to learn more.
# Cancel Workflow Action

This is a GitHub Action that will cancel any previous runs that are not `completed` for a given workflow.
Expand Down

0 comments on commit 3b7e3bd

Please sign in to comment.