Allow matching SHA to be canceled

[ericmatte]

Hi,

I've started using your action and it is really useful!

However, their was one use case for me that was not working:

• I have a workflow which temporally build and deploy a version of my app on every pull_request.
• I have a second workflow which cleanup the temporary deployment on pull_request: types: [closed].
  • That second workflow call your action to cancel any build runs still running after the PR is closed.

The problem is that it will not cancel the latest build run if I merge that commit directly; since they both have the same SHA.

So I've added an option allow_matching_sha (default to false) which can disable that check and allow runs with the same sha on other workflows to be cancelled.

So my second workflow looks like this:

on:
  pull_request:
    types: [closed]

jobs:
  cleanup-after-pr-closed:
    name: Cleanup After PR Closed
    runs-on: ubuntu-latest
    steps:
      - name: Cancel build runs
        uses: ericmatte/cancel-workflow-action@match-sha
        with:
          allow_matching_sha: true
          workflow_id: '######'

Cheers

[styfle]

Hi @ericmatte

It seems like this is only relevant for pull_request: closed. I can't think of a reason why you would want this for the push event.

I wonder if it would be better to detect the event type and do this automatically for closed PRs rather than add a new option?

[ericmatte]

@styfle, yes, in my case, it is only useful on pull_request: closed.

I can't think of a reason why you would want this for the push event.

I could think of one reason: Let's say that you have two workflows which are triggered on push that are both doing long jobs.
If a job has failed or is canceled in one of the workflow, maybe you would want to cancel the other one too:

jobs:
  cleanup-after-pr-closed:
    name: Cancel other workflows on failure
    runs-on: ubuntu-latest
    need: [other-jobs]
    if: failure() # or cancelled()
    steps:
        uses: ericmatte/cancel-workflow-action@match-sha
        with:
          allow_matching_sha: true
          workflow_id: 'other-workflow.yml'

If you don't think that this could be a useful case, I could also change the code like you've suggested and detect the event type to do this only on closed PRs.

Cheers

[styfle]

Lets rename the option ignore_sha and it should be optional, not required