actions-marketplace-validations/Stale Branches

Finds and deletes stale branches

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
repo-tokenThe token to be used to auth with GitHubs API. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`no${{ github.token }}
days-before-staleNumber of days a branch has been inactive before it is considered stale. Default: 120.no120
days-before-deleteNumber of days a branch has been inactive before it is deleted. Default: 180.no180
comment-updatesIf this is enabled, a comment with updated information will be added to existing issues each workflow run.nofalse
max-issuesThis dictates the number of Stale issues that can exist. It also limits the number of branches that can be deleted per run.no20
tag-committerWhen an issue is opened, this will tag the stale branchs last committer in the comments.nofalse
stale-branch-labelLabel to be applied to issues created for stale branches.nostale branch 🗑️
compare-branchesCompares current branch with default branch. Options: off | info | savenooff
branches-filter-regexAn optional Regex that will be used to filter branches from this action.no""
rate-limitIf this is enabled, the action will stop if it exceeds 95% of the GitHub API rate limit.notrue
pr-checkIf this is enabled, the action will first check for active pull requests against the branch. If a branch has an active pr, it will not be ignored.nofalse
dry-runIf this is enabled, the action will not delete or tag any branches.nofalse
ignore-issue-interactionIf this is enabled, the action will not interact with Github issues.nofalse
include-protected-branchesIf this is enabled, the action will include branches with legacy branch protection rules in the process.nofalse
include-ruleset-branchesIf this is enabled, the action will include branches protected by repository rulesets in the process.nofalse
ignore-commit-messagesComma-separated list of commit messages (or substrings) to ignore when determining commit age. If provided, commits with these messages will be ignored when calculating branch age.no
ignore-committersComma-separated list of committer usernames to ignore when calculating the most recent commit.no""
ignore-default-branch-commitsIf true, ignore commits that are also present in the default branch when determining the last meaningful commit.nofalse
namedescription
deleted-branchesList of all deleted branches.
stale-branchesList of all stale branches.