Skip to content
play

GitHub Action

stale-branch-action

v1.14.0 Latest version

stale-branch-action

play

stale-branch-action

Delete stale branches

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: stale-branch-action

              
  uses: int128/stale-branch-action@v1.14.0
Learn more about this action in int128/stale-branch-action

Choose a version

stale-branch-action ts

This action deletes stale branches.

Getting Started

It deletes a branch if the following conditions are satisfied:

  • The committed date is older than the expiration
  • The branch does not have open pull request(s)

To delete branches older than 30 days,

jobs:
  delete:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/stale-branch-action@v1
        with:
          expiration-days: 30

Filter branches

You can filter the branches by prefix. For example,

jobs:
  delete:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/stale-branch-action@v1
        with:
          expiration-days: 1
          ref-prefix: refs/heads/renovate/

Note that ref-prefix must have a traling slash, due to the limitation of GitHub API.

Exclude branches

You can exclude branches by glob patterns. For example,

jobs:
  delete:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/stale-branch-action@v1
        with:
          expiration-days: 30
          exclude-refs: |
            refs/heads/*/production

Ignore deletion errors

This action deletes the stale branches using git push origin --delete command. If a branch protection rule is set, this action cannot delete the branch.

To ignore any error on deletion,

jobs:
  delete:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/stale-branch-action@v1
        with:
          expiration-days: 30
          ignore-deletion-errors: true

Specification

Inputs

Name Default Description
expiration-days (required) Expiration in days
ref-prefix refs/heads/ Prefix of refs
exclude-refs - Exclude ref by pattern (multiline string)
dry-run false Do not delete refs actually
ignore-deletion-errors false Ignore any errors of git push origin --delete
token github.token GitHub token

Outputs

Name Description
stale-refs Stale ref names (multiline string)