https://github.com/int128/stale-branch-action
Delete stale branches in GitHub Actions
https://github.com/int128/stale-branch-action
github-actions stale
Last synced: 4 months ago
JSON representation
Delete stale branches in GitHub Actions
- Host: GitHub
- URL: https://github.com/int128/stale-branch-action
- Owner: int128
- License: apache-2.0
- Created: 2023-08-11T23:07:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-14T02:00:17.000Z (4 months ago)
- Last Synced: 2025-06-14T02:40:06.346Z (4 months ago)
- Topics: github-actions, stale
- Language: TypeScript
- Homepage:
- Size: 5.65 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stale-branch-action [](https://github.com/int128/stale-branch-action/actions/workflows/ts.yaml)
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,
```yaml
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,
```yaml
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,
```yaml
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,
```yaml
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) |