Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1 from mscoutermarsh/patch-1
Browse files Browse the repository at this point in the history
Readme ✨
  • Loading branch information
Andy McKay committed Jan 29, 2020
2 parents 8f8510d + 77c1af1 commit 8debe72
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
This Action uses the [GitHub API](https://developer.github.com/v3/actions/workflow_runs/#cancel-a-workflow-run) to cancel the workflow. Example usage:
## Cancel Action
This Action uses the [GitHub API](https://developer.github.com/v3/actions/workflow_runs/#cancel-a-workflow-run) to cancel the currently running workflow. Example usage:

```
```yaml
- name: cancelling
uses: andymckay/cancel-action@master
uses: andymckay/cancel-action@0.2
```

The cancellation might take a few seconds to process, this is most useful when you'd like to cancel a long running build. In combination with the `if` statement, this allows you to cancel the build conditionally.

0 comments on commit 8debe72

Please sign in to comment.