Skip to content

Cancel workflows when pr is force merged/closed #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yhmo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Cancel workflows when pr is force merged/closed #508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions .github/workflows/cleanup-pr-caches.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,34 @@ permissions:
pull-requests: read

jobs:
# When a PR is closed, delete all GitHub Actions caches associated with the PR's merge ref (refs/pull/PR_NUMBER/merge).
# When a PR is closed, cancel any still-running pull_request workflow runs for
# that PR and delete all GitHub Actions caches associated with the PR's merge
# ref (refs/pull/PR_NUMBER/merge).
cleanup:
name: Cleanup PR caches
name: Cleanup PR actions state
runs-on: ubuntu-latest
steps:
- name: Cancel PR workflow runs
env:
GH_TOKEN: ${{ github.token }}
GH_REPO: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }}
RUN_ID: ${{ github.run_id }}
run: |
set -euo pipefail
run_ids=$(gh api --paginate "repos/$GH_REPO/actions/runs?event=pull_request&status=in_progress&per_page=100" --jq '.workflow_runs[] | select(.id != (env.RUN_ID | tonumber) and any(.pull_requests[]?; .number == (env.PR_NUMBER | tonumber))) | .id')
queued_run_ids=$(gh api --paginate "repos/$GH_REPO/actions/runs?event=pull_request&status=queued&per_page=100" --jq '.workflow_runs[] | select(.id != (env.RUN_ID | tonumber) and any(.pull_requests[]?; .number == (env.PR_NUMBER | tonumber))) | .id')
run_ids=$(printf '%s\n%s\n' "$run_ids" "$queued_run_ids" | sed '/^$/d' | sort -u)
Comment thread
yhmo marked this conversation as resolved.
if [ -z "$run_ids" ]; then
echo "No queued or in-progress pull_request runs found for PR #$PR_NUMBER"
else
while read -r run_id; do
if ! gh api --method POST "repos/$GH_REPO/actions/runs/$run_id/cancel"; then
echo "Run $run_id could not be cancelled, likely because it already finished"
fi
done <<< "$run_ids"
fi

- name: Delete PR caches
env:
GH_TOKEN: ${{ github.token }}
Expand Down
Loading