Skip to main content

Stale issue label input

Input​

Name: issue-stale-label
Type: string
Default value: stale

Description​

This input will let you define the label (by name) that will be added to your issues when they are considered as stale.

If the label is added to an issue (based on the days before stale input), the next time the issue is processed, the workflow will process it as a candidate for un-stale.
If the issue was updated after the addition of the label, the issue will be un-stale, and the label will be removed.

Once the un-stale processing is done, if the issue is still stale, the workflow will then process it as a candidate for closing.
If the issue is stale for too long (based on the days before close input), the issue will be closed.

caution

The label must be a real label, existing inside your repository list of labels (github.com/your-organization/your-repository/labels).
If not, the GitHub API will throw an error.

Cache​

The label will be cached during the workflow.
This will reduce the number of calls made to the GitHub API, which will also reduce the quotas consumed for your GitHub token, avoiding reaching rate limits.

Example​

# ...
name: Stale
id: stale
uses: sonia-corporation/stale@latest
with:
  issue-stale-label: stale-label