cleanup-caches-by-a-branch.yml

---
name: cleanup caches by a branch
on: # yamllint disable-line rule:truthy
  pull_request:
    types:
      - closed
  workflow_dispatch: # yamllint disable-line rule:empty-values

jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v4

      - name: Cleanup
        run: |
          gh extension install actions/gh-actions-cache

          echo "Fetching list of cache key"
          cacheKeysForPR=$(gh actions-cache list -R "${REPO}" -B "${BRANCH}" | cut -f 1 )

          ## Setting this to not fail the workflow while deleting cache keys.
          set +e
          echo "Deleting caches..."
          for cacheKey in $cacheKeysForPR
          do
              echo "Deleting cacheKey... ${cacheKey}"
              gh actions-cache delete "${cacheKey}" -R "${REPO}" -B "${BRANCH}" --confirm
          done
          echo "Done"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REPO: ${{ github.repository }}
          # BRANCH: ${{ github.ref }}
          # https://github.com/github/docs/issues/22727
          # BRANCH: 'refs/pull/${{ github.event.pull_request.number }}/merge'
          # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-your-workflow-based-on-the-head-or-base-branch-of-a-pull-request
          BRANCH: ${{ github.head_ref }}