Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.73 KB
Raw

Cancel Workflow Action

This is a Github Action that will cancel any previous runs that are not completed for a given workflow.

This includes runs with a status of queued or in_progress.

How does it work?

When you git push, this action will capture the Branch and SHA. It will query GitHub's API to find workflow runs that match the Branch but do not match the SHA (these would be previous pushes) and cancel all of these in-progress runs so that the latest run (current SHA) will finish.

Read more about the Workflow Runs API.

Usage

  • Visit https://github.com/settings/tokens to generate a token with public_repo scope (or full repo scope for private repos).
  • Visit https://github.com/:org/:repo/settings/secrets to add a secret called GH_ACCESS_TOKEN with the token as the value.
  • Visit https://api.github.com/repos/:org/:repo/actions/workflows to find the Workflow ID you wish to auto-cancel.
  • Add a new file .github/workflows/cancel.yml with the following:
name: Cancel
on: [push]
jobs:
  cancel:
    name: 'Cancel Previous Runs'
    runs-on: ubuntu-latest
    timeout-minutes: 3
    steps:
      - uses: styfle/[email protected]
        with:
          workflow_id: 479426
          access_token: ${{ secrets.GH_ACCESS_TOKEN }}

Note: workflow_id accepts a comma separated list of IDs.

At the time of writing 0.3.1 is the latest release but you can select any release.

Contributing

  • Clone this repo
  • Run yarn install
  • Edit ./src/index.ts
  • Run yarn build
  • Commit changes including ./dist/index.js bundle