Souji Action is a GitHub Action that deletes all GitHub Actions Caches related to the context of the triggered workflow event, without any configuration required.

GitHub Actions Caches have branch scope restriction in place. This means that there are caches that will never be restored in the future. This action allows you to easily delete such caches.

Souji-action can be used either as a reusable workflow or as an action.

actions:write permission is required to delete caches.
contents:read permission is required to checkout private repositories.

• Reusable workflow

name: cleanup caches by a branch
on:
  pull_request_target:
    types:
      - closed
  delete:
  workflow_dispatch:
    inputs:
      branchNames:
        description: 'List of branch(ref) names with caches to be deleted'
        required: false
        type: string

jobs:
  cleanup:
    permissions:
      actions: write
      contents: read
    uses: 4m-mazi/souji-action/.github/workflows/_souji.yml@v1.4.8
    with:
      branch-names: ${{ inputs.branchNames }}

• Action

name: cleanup caches by a branch
on:
  pull_request_target:
    types:
      - closed
  delete:
  workflow_dispatch:
    inputs:
      branchNames:
        description: 'List of branch(ref) names with caches to be deleted'
        required: false
        type: string

jobs:
  cleanup:
    runs-on: ubuntu-latest
    permissions:
      actions: write
    steps:
      - name: Cleanup
        uses: 4m-mazi/souji-action@v1.4.8
        with:
          branch-names: ${{ inputs.branchNames }}

These workflows cleans up caches for branches when they are merged(closed) or deleted.
This will clear the following cache:

• merge ref refs/pull/<number>/merge
  • When a pull request is merged or closed, this workflow removes cached data associated with the merge ref.
• branch <branch name>
  • When a branch is deleted, this workflow deletes the cached data associated with the branch.

branch-names: |
  main
  refs/pull/123/merge
  refs/tags/1.0.0

branch-names: main refs/pull/123/merge refs/tags/1.0.0

All inputs are optional.

If branch-names is not specified, the value derived from the context of the event is used as the default value.