Stale pull request label input
Input
Name: pull-request-stale-label
Type: string
Default value: stale
Description
This input will let you define the label (by name) that will be added to your pull requests when they are considered as stale.
If the label is added to a pull request (based on the days before stale input), the next time the pull request is processed, the workflow will process it as a candidate for un-stale.
If the pull request was updated after the addition of the label, the pull request will be un-stale, and the label will be removed.
Once the un-stale processing is done, if the pull request is still stale, the workflow will then process it as a candidate for closing.
If the pull request is stale for too long (based on the days before close input), the pull request will be closed.
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.
You may find useful to convert your pull requests to draft instead of stale.
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:
pull-request-stale-label: stale-label