From 67004407a6a06b621969a09f818cc9b477f0d733 Mon Sep 17 00:00:00 2001 From: TESTELIN Geoffrey Date: Fri, 8 Oct 2021 22:42:12 +0200 Subject: [PATCH] docs(readme): split the options between common, issues and prs --- README.md | 570 +++++++++++++++++++++++++++--------------------------- 1 file changed, 287 insertions(+), 283 deletions(-) diff --git a/README.md b/README.md index ef500f5d..c7889dbc 100644 --- a/README.md +++ b/README.md @@ -30,45 +30,49 @@ Every argument is optional. | Input | Description | Default | | ------------------------------------------------------------------- | ----------------------------------------------------------------------- | --------------------- | +| Common options | | | | [repo-token](#repo-token) | PAT for GitHub API authentication | `${{ github.token }}` | -| [days-before-issue-stale](#days-before-issue-stale) | Idle number of days before marking issues stale | `60` | -| [days-before-pr-stale](#days-before-pr-stale) | Idle number of days before marking PRs stale | `60` | -| [days-before-issue-close](#days-before-issue-close) | Idle number of days before closing stale issues | `7` | -| [days-before-pr-close](#days-before-pr-close) | Idle number of days before closing stale PRs | `7` | -| [stale-issue-message](#stale-issue-message) | Comment on the staled issues | | -| [stale-pr-message](#stale-pr-message) | Comment on the staled PRs | | -| [close-issue-message](#close-issue-message) | Comment on the staled issues while closed | | -| [close-pr-message](#close-pr-message) | Comment on the staled PRs while closed | | -| [stale-issue-label](#stale-issue-label) | Label to apply on staled issues | `Stale` | -| [close-issue-label](#close-issue-label) | Label to apply on closed issues | | -| [stale-pr-label](#stale-pr-label) | Label to apply on staled PRs | `Stale` | -| [close-pr-label](#close-pr-label) | Label to apply on closed PRs | | -| [exempt-issue-labels](#exempt-issue-labels) | Labels on issues exempted from stale | | -| [exempt-pr-labels](#exempt-pr-labels) | Labels on PRs exempted from stale | | -| [only-issue-labels](#only-issue-labels) | Only issues with ALL these labels are checked | | -| [only-pr-labels](#only-pr-labels) | Only PRs with ALL these labels are checked | | -| [any-of-issue-labels](#any-of-issue-labels) | Only issues with ANY of these labels are checked | | -| [any-of-pr-labels](#any-of-pr-labels) | Only PRs with ANY of these labels are checked | | | [operations-per-run](#operations-per-run) | Max number of operations per run | `30` | -| [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issues on updates/comments | `true` | -| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PRs on updates/comments | `true` | | [labels-to-add-when-unstale](#labels-to-add-when-unstale) | Add specified labels from issues/PRs when they become unstale | | | [labels-to-remove-when-unstale](#labels-to-remove-when-unstale) | Remove specified labels from issues/PRs when they become unstale | | | [debug-only](#debug-only) | Dry-run | `false` | | [ascending](#ascending) | Order to get issues/PRs | `false` | | [start-date](#start-date) | Skip stale action for issues/PRs created before it | | | [delete-branch](#delete-branch) | Delete branch after closing a stale PR | `false` | +| [enable-statistics](#enable-statistics) | Display statistics in the logs | `true` | +| Issue options | | | +| [days-before-issue-stale](#days-before-issue-stale) | Idle number of days before marking issues stale | `60` | +| [days-before-issue-close](#days-before-issue-close) | Idle number of days before closing stale issues | `7` | +| [stale-issue-message](#stale-issue-message) | Comment on the staled issues | | +| [close-issue-message](#close-issue-message) | Comment on the staled issues while closed | | +| [stale-issue-label](#stale-issue-label) | Label to apply on staled issues | `Stale` | +| [close-issue-label](#close-issue-label) | Label to apply on closed issues | | +| [exempt-issue-labels](#exempt-issue-labels) | Labels on issues exempted from stale | | +| [only-issue-labels](#only-issue-labels) | Only issues with ALL these labels are checked | | +| [any-of-issue-labels](#any-of-issue-labels) | Only issues with ANY of these labels are checked | | +| [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issues on updates/comments | `true` | | [exempt-issue-milestones](#exempt-issue-milestones) | Milestones on issues exempted from stale | | -| [exempt-pr-milestones](#exempt-pr-milestones) | Milestones on PRs exempted from stale | | | [exempt-all-issue-milestones](#exempt-all-issue-milestones) | Exempt all issues with milestones from stale | `false` | -| [exempt-all-pr-milestones](#exempt-all-pr-milestones) | Exempt all PRs with milestones from stale | `false` | | [exempt-issue-assignees](#exempt-issue-assignees) | Assignees on issues exempted from stale | | -| [exempt-pr-assignees](#exempt-pr-assignees) | Assignees on PRs exempted from stale | | | [exempt-all-issue-assignees](#exempt-all-issue-assignees) | Exempt all issues with assignees from stale | `false` | +| [ignore-issue-updates](#ignore-issue-updates) | Any update (update/comment) can reset the stale idle time on the issues | `false` | +| Pull request options | | | +| [days-before-pr-stale](#days-before-pr-stale) | Idle number of days before marking PRs stale | `60` | +| [days-before-pr-close](#days-before-pr-close) | Idle number of days before closing stale PRs | `7` | +| [stale-pr-message](#stale-pr-message) | Comment on the staled PRs | | +| [close-pr-message](#close-pr-message) | Comment on the staled PRs while closed | | +| [stale-pr-label](#stale-pr-label) | Label to apply on staled PRs | `Stale` | +| [close-pr-label](#close-pr-label) | Label to apply on closed PRs | | +| [exempt-pr-labels](#exempt-pr-labels) | Labels on PRs exempted from stale | | +| [only-pr-labels](#only-pr-labels) | Only PRs with ALL these labels are checked | | +| [any-of-pr-labels](#any-of-pr-labels) | Only PRs with ANY of these labels are checked | | +| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PRs on updates/comments | `true` | +| [delete-branch](#delete-branch) | Delete branch after closing a stale PR | `false` | +| [exempt-pr-milestones](#exempt-pr-milestones) | Milestones on PRs exempted from stale | | +| [exempt-all-pr-milestones](#exempt-all-pr-milestones) | Exempt all PRs with milestones from stale | `false` | +| [exempt-pr-assignees](#exempt-pr-assignees) | Assignees on PRs exempted from stale | | | [exempt-all-pr-assignees](#exempt-all-pr-assignees) | Exempt all PRs with assignees from stale | `false` | | [exempt-draft-pr](#exempt-draft-pr) | Skip the stale action for draft PRs | `false` | -| [enable-statistics](#enable-statistics) | Display statistics in the logs | `true` | -| [ignore-issue-updates](#ignore-issue-updates) | Any update (update/comment) can reset the stale idle time on the issues | `false` | | [ignore-pr-updates](#ignore-pr-updates) | Any update (update/comment) can reset the stale idle time on the PRs | `false` | ### List of output options @@ -87,212 +91,6 @@ Under the hood, it uses the [@actions/github](https://www.npmjs.com/package/@act Default value: `${{ github.token }}` -#### days-before-issue-stale - -The idle number of days before marking the issues as stale (by adding a label). -The issues will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. -It means that any updates made, or any comments added to the issues will restart the counter of days before marking as stale. -However, if you wish to ignore this behaviour so that the creation date (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`) only matters, you can disable the [ignore-issue-updates](#ignore-issue-updates) option. - -If set to a negative number like `-1`, no issues will be marked as stale automatically. -In that case, you can still add the stale label manually to mark as stale. - -The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) - -A comment can also be added to notify about the stale and is defined by this option: [stale-pr-message](#stale-pr-message) - -You can fine tune which issues should be marked as stale based on the milestones, the assignees, the creation date and the missing/present labels from these options: - -- [exempt-issue-labels](#exempt-issue-labels) -- [only-issue-labels](#only-issue-labels) -- [any-of-issue-labels](#any-of-issue-labels) -- [start-date](#start-date) -- [exempt-issue-milestones](#exempt-issue-milestones) -- [exempt-all-issue-milestones](#exempt-all-issue-milestones) -- [exempt-issue-assignees](#exempt-issue-assignees) -- [exempt-all-issue-assignees](#exempt-all-issue-assignees) -- [ignore-issue-updates](#ignore-issue-updates) - -Default value: `60` - -#### days-before-pr-stale - -The idle number of days before marking the pull requests as stale (by adding a label). -The pull requests will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. -It means that any updates made, or any comments added to the pull requests will restart the counter of days before marking as stale. -However, if you wish to ignore this behaviour so that the creation date (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`) only matters, you can disable the [ignore-pr-updates](#ignore-pr-updates) option. - -If set to a negative number like `-1`, no pull requests will be marked as stale automatically. -In that case, you can still add the stale label manually to mark as stale. - -The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) - -A comment can also be added to notify about the stale and is defined by this option: [stale-pr-message](#stale-pr-message) - -You can fine tune which pull requests should be marked as stale based on the milestones, the assignees, the creation date and the missing/present labels from these options: - -- [exempt-pr-labels](#exempt-pr-labels) -- [only-pr-labels](#only-pr-labels) -- [any-of-pr-labels](#any-of-pr-labels) -- [start-date](#start-date) -- [exempt-pr-milestones](#exempt-pr-milestones) -- [exempt-all-pr-milestones](#exempt-all-pr-milestones) -- [exempt-pr-assignees](#exempt-pr-assignees) -- [exempt-all-pr-assignees](#exempt-all-pr-assignees) -- [ignore-pr-updates](#ignore-pr-updates) - -Default value: `60` - -#### days-before-issue-close - -The idle number of days before closing the stale issues (due to the stale label). -The issues will be closed if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. -Since adding the stale label will alter the last update date, we can calculate the number of days from this date. - -If set to a negative number like `-1`, the issues will never be closed automatically. - -The label used to stale is defined by this option: [stale-issue-label](#stale-issue-label) - -Default value: `7` - -#### days-before-pr-close - -The idle number of days before closing the stale pull requests (due to the stale label). -The pull requests will be closed if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. -Since adding the stale label will alter the last update date, we can calculate the number of days from this date. - -If set to a negative number like `-1`, the pull requests will never be closed automatically. - -The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) - -Default value: `7` - -#### stale-issue-message - -The message that will be added as a comment to the issues when the stale workflow marks it automatically as stale with a label. - -You can skip the comment sending by passing an empty string. - -Default value: unset -Required Permission: `issues: write` - -#### stale-pr-message - -The message that will be added as a comment to the pull requests when the stale workflow marks it automatically as stale with a label. - -You can skip the comment sending by passing an empty string. - -Default value: unset -Required Permission: `pull-requests: write` - -#### close-issue-message - -The message that will be added as a comment to the issues when the stale workflow closes it automatically after being stale for too long. - -Default value: unset -Required Permission: `issues: write` - -#### close-pr-message - -The message that will be added as a comment to the pull requests when the stale workflow closes it automatically after being stale for too long. - -Default value: unset -Required Permission: `pull-requests: write` - -#### stale-issue-label - -The label that will be added to the issues when automatically marked as stale. -If you wish to speedup the stale workflow for the issues, you can add this label manually to mark as stale. - -Default value: `Stale` -Required Permission: `issues: write` - -#### close-issue-label - -The label that will be added to the issues when closed automatically. -It will be automatically removed if the issues are no longer closed nor locked. - -Default value: unset -Required Permission: `issues: write` - -#### stale-pr-label - -The label that will be added to the pull requests when automatically marked as stale. -If you wish to speedup the stale workflow for the pull requests, you can add this label manually to mark as stale. - -Default value: `Stale` -Required Permission: `pull-requests: write` - -#### close-pr-label - -The label that will be added to the pull requests when closed automatically. -It will be automatically removed if the pull requests are no longer closed nor locked. - -Default value: unset -Required Permission: `pull-requests: write` - -#### exempt-issue-labels - -The label(s) that can exempt to automatically mark as stale the issues. -It can be a comma separated list of labels (e.g: `question,bug`). - -If unset (or an empty string), this option will not alter the stale workflow. - -Default value: unset - -#### exempt-pr-labels - -The label(s) that can exempt to automatically mark as stale the pull requests. -It can be a comma separated list of labels (e.g: `need-help,WIP`). - -If unset (or an empty string), this option will not alter the stale workflow. - -Default value: unset - -#### only-issue-labels - -An allow-list of label(s) to only process the issues that contain all these label(s). -It can be a comma separated list of labels (e.g: `answered,needs-rebase`). - -If unset (or an empty string), this option will not alter the stale workflow. - -If you wish to only check that the issues contain one of these label(s), use instead [any-of-issue-labels](#any-of-issue-labels). - -Default value: unset - -#### only-pr-labels - -An allow-list of label(s) to only process the pull requests that contain all these label(s). -It can be a comma separated list of labels (e.g: `answered,needs-rebase`). - -If unset (or an empty string), this option will not alter the stale workflow. - -If you wish to only check that the pull requests contain one of these label(s), use instead [any-of-pr-labels](#any-of-pr-labels). - -Default value: unset - -#### any-of-issue-labels - -An allow-list of label(s) to only process the issues that contain one of these label(s). -It can be a comma separated list of labels (e.g: `answered,needs-rebase`). - -If unset (or an empty string), this option will not alter the stale workflow. - -If you wish to only check that the issues or the pull requests contain all these label(s), use instead [only-issue-labels](#only-issue-labels). - -Default value: unset - -#### any-of-pr-labels - -An allow-list of label(s) to only process the pull requests that contain one of these label(s). -It can be a comma separated list of labels (e.g: `answered,needs-rebase`). - -If unset (or an empty string), this option will not alter the stale workflow. - -If you wish to only check that the issues or the pull requests contain all these label(s), use instead [only-pr-labels](#only-pr-labels). - -Default value: unset - #### operations-per-run _Context:_ @@ -314,20 +112,6 @@ Only the [actor](#repo-token) and the batch of issues (100 per batch) will consu Default value: `30` -#### remove-issue-stale-when-updated - -Automatically remove the stale label when the issues are updated (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) or commented. - -Default value: `true` -Required Permission: `issues: write` - -#### remove-pr-stale-when-updated - -Automatically remove the stale label when the pull requests are updated (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) or commented. - -Default value: `true` -Required Permission: `pull-requests: write` - #### labels-to-add-when-unstale A comma delimited list of labels to add when a stale issue or pull request receives activity and has the [stale-issue-label](#stale-issue-label) or [stale-pr-label](#stale-pr-label) removed from it. @@ -379,18 +163,126 @@ If set to `true`, the stale workflow will automatically delete the GitHub branch Default value: `false` Required Permission: `pull-requests: write` -#### exempt-issue-milestones +#### enable-statistics -A white-list of milestone(s) to only process the issues that does not contain one of these milestone(s). -It can be a comma separated list of milestones (e.g: `V1,next`). +Collects and display statistics at the end of the stale workflow logs to get a summary of what happened during the run. +This option is only useful if the debug output secret `ACTIONS_STEP_DEBUG` is set to `true` in your repository to display the logs. + +Default value: `true` + +#### days-before-issue-stale + +The idle number of days before marking the issues as stale (by adding a label). +The issues will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. +It means that any updates made, or any comments added to the issues will restart the counter of days before marking as stale. +However, if you wish to ignore this behaviour so that the creation date (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`) only matters, you can disable the [ignore-issue-updates](#ignore-issue-updates) option. + +If set to a negative number like `-1`, no issues will be marked as stale automatically. +In that case, you can still add the stale label manually to mark as stale. + +The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) + +A comment can also be added to notify about the stale and is defined by this option: [stale-pr-message](#stale-pr-message) + +You can fine tune which issues should be marked as stale based on the milestones, the assignees, the creation date and the missing/present labels from these options: + +- [exempt-issue-labels](#exempt-issue-labels) +- [only-issue-labels](#only-issue-labels) +- [any-of-issue-labels](#any-of-issue-labels) +- [start-date](#start-date) +- [exempt-issue-milestones](#exempt-issue-milestones) +- [exempt-all-issue-milestones](#exempt-all-issue-milestones) +- [exempt-issue-assignees](#exempt-issue-assignees) +- [exempt-all-issue-assignees](#exempt-all-issue-assignees) +- [ignore-issue-updates](#ignore-issue-updates) + +Default value: `60` + +#### days-before-issue-close + +The idle number of days before closing the stale issues (due to the stale label). +The issues will be closed if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. +Since adding the stale label will alter the last update date, we can calculate the number of days from this date. + +If set to a negative number like `-1`, the issues will never be closed automatically. + +The label used to stale is defined by this option: [stale-issue-label](#stale-issue-label) + +Default value: `7` + +#### stale-issue-message + +The message that will be added as a comment to the issues when the stale workflow marks it automatically as stale with a label. + +You can skip the comment sending by passing an empty string. + +Default value: unset +Required Permission: `issues: write` + +#### close-issue-message + +The message that will be added as a comment to the issues when the stale workflow closes it automatically after being stale for too long. + +Default value: unset +Required Permission: `issues: write` + +#### stale-issue-label + +The label that will be added to the issues when automatically marked as stale. +If you wish to speedup the stale workflow for the issues, you can add this label manually to mark as stale. + +Default value: `Stale` +Required Permission: `issues: write` + +#### close-issue-label + +The label that will be added to the issues when closed automatically. +It will be automatically removed if the issues are no longer closed nor locked. + +Default value: unset +Required Permission: `issues: write` + +#### exempt-issue-labels + +The label(s) that can exempt to automatically mark as stale the issues. +It can be a comma separated list of labels (e.g: `question,bug`). If unset (or an empty string), this option will not alter the stale workflow. Default value: unset -#### exempt-pr-milestones +#### only-issue-labels -A white-list of milestone(s) to only process the pull requests that does not contain one of these milestone(s). +An allow-list of label(s) to only process the issues that contain all these label(s). +It can be a comma separated list of labels (e.g: `answered,needs-rebase`). + +If unset (or an empty string), this option will not alter the stale workflow. + +If you wish to only check that the issues contain one of these label(s), use instead [any-of-issue-labels](#any-of-issue-labels). + +Default value: unset + +#### any-of-issue-labels + +An allow-list of label(s) to only process the issues that contain one of these label(s). +It can be a comma separated list of labels (e.g: `answered,needs-rebase`). + +If unset (or an empty string), this option will not alter the stale workflow. + +If you wish to only check that the issues or the pull requests contain all these label(s), use instead [only-issue-labels](#only-issue-labels). + +Default value: unset + +#### remove-issue-stale-when-updated + +Automatically remove the stale label when the issues are updated (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) or commented. + +Default value: `true` +Required Permission: `issues: write` + +#### exempt-issue-milestones + +A white-list of milestone(s) to only process the issues that does not contain one of these milestone(s). It can be a comma separated list of milestones (e.g: `V1,next`). If unset (or an empty string), this option will not alter the stale workflow. @@ -405,14 +297,6 @@ Priority over [exempt-issue-milestones](#exempt-issue-milestones). Default value: `false` -#### exempt-all-pr-milestones - -If set to `true`, the pull requests with a milestone will not be marked as stale automatically. - -Priority over [exempt-pr-milestones](#exempt-pr-milestones). - -Default value: `false` - #### exempt-issue-assignees An allow-list of assignee(s) to only process the issues that does not contain one of these assignee(s). @@ -422,15 +306,6 @@ If unset (or an empty string), this option will not alter the stale workflow. Default value: unset -#### exempt-pr-assignees - -An allow-list of assignee(s) to only process the pull requests that does not contain one of these assignee(s). -It can be a comma separated list of assignees (e.g: `marco,polo`). - -If unset (or an empty string), this option will not alter the stale workflow. - -Default value: unset - #### exempt-all-issue-assignees If set to `true`, the issues with an assignee will not be marked as stale automatically. @@ -439,6 +314,151 @@ Priority over [exempt-issue-assignees](#exempt-issue-assignees). Default value: `false` +#### ignore-issue-updates + +The option [days-before-issue-stale](#days-before-issue-stale) will define the number of days before considering the issues or the pull requests as stale. +In most cases, the purpose of this action is to only stale when necessary so if any update occurs or if a comment is added to them, the counter will restart. +Nonetheless, if you don't care about this, and you prefer to stick to this number of days no matter the update, you can enable this option. +Instead of comparing the number of days based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`, it will be based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`. + +Default value: `false` + +#### days-before-pr-stale + +The idle number of days before marking the pull requests as stale (by adding a label). +The pull requests will be marked as stale if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. +It means that any updates made, or any comments added to the pull requests will restart the counter of days before marking as stale. +However, if you wish to ignore this behaviour so that the creation date (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`) only matters, you can disable the [ignore-pr-updates](#ignore-pr-updates) option. + +If set to a negative number like `-1`, no pull requests will be marked as stale automatically. +In that case, you can still add the stale label manually to mark as stale. + +The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) + +A comment can also be added to notify about the stale and is defined by this option: [stale-pr-message](#stale-pr-message) + +You can fine tune which pull requests should be marked as stale based on the milestones, the assignees, the creation date and the missing/present labels from these options: + +- [exempt-pr-labels](#exempt-pr-labels) +- [only-pr-labels](#only-pr-labels) +- [any-of-pr-labels](#any-of-pr-labels) +- [start-date](#start-date) +- [exempt-pr-milestones](#exempt-pr-milestones) +- [exempt-all-pr-milestones](#exempt-all-pr-milestones) +- [exempt-pr-assignees](#exempt-pr-assignees) +- [exempt-all-pr-assignees](#exempt-all-pr-assignees) +- [ignore-pr-updates](#ignore-pr-updates) + +Default value: `60` + +#### days-before-pr-close + +The idle number of days before closing the stale pull requests (due to the stale label). +The pull requests will be closed if the last update (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) is older than the idle number of days. +Since adding the stale label will alter the last update date, we can calculate the number of days from this date. + +If set to a negative number like `-1`, the pull requests will never be closed automatically. + +The label used to stale is defined by this option: [stale-pr-label](#stale-pr-label) + +Default value: `7` + +#### stale-pr-message + +The message that will be added as a comment to the pull requests when the stale workflow marks it automatically as stale with a label. + +You can skip the comment sending by passing an empty string. + +Default value: unset +Required Permission: `pull-requests: write` + +#### close-pr-message + +The message that will be added as a comment to the pull requests when the stale workflow closes it automatically after being stale for too long. + +Default value: unset +Required Permission: `pull-requests: write` + +#### stale-pr-label + +The label that will be added to the pull requests when automatically marked as stale. +If you wish to speedup the stale workflow for the pull requests, you can add this label manually to mark as stale. + +Default value: `Stale` +Required Permission: `pull-requests: write` + +#### close-pr-label + +The label that will be added to the pull requests when closed automatically. +It will be automatically removed if the pull requests are no longer closed nor locked. + +Default value: unset +Required Permission: `pull-requests: write` + +#### exempt-pr-labels + +The label(s) that can exempt to automatically mark as stale the pull requests. +It can be a comma separated list of labels (e.g: `need-help,WIP`). + +If unset (or an empty string), this option will not alter the stale workflow. + +Default value: unset + +#### only-pr-labels + +An allow-list of label(s) to only process the pull requests that contain all these label(s). +It can be a comma separated list of labels (e.g: `answered,needs-rebase`). + +If unset (or an empty string), this option will not alter the stale workflow. + +If you wish to only check that the pull requests contain one of these label(s), use instead [any-of-pr-labels](#any-of-pr-labels). + +Default value: unset + +#### any-of-pr-labels + +An allow-list of label(s) to only process the pull requests that contain one of these label(s). +It can be a comma separated list of labels (e.g: `answered,needs-rebase`). + +If unset (or an empty string), this option will not alter the stale workflow. + +If you wish to only check that the issues or the pull requests contain all these label(s), use instead [only-pr-labels](#only-pr-labels). + +Default value: unset + +#### remove-pr-stale-when-updated + +Automatically remove the stale label when the pull requests are updated (based on [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`) or commented. + +Default value: `true` +Required Permission: `pull-requests: write` + +#### exempt-pr-milestones + +A white-list of milestone(s) to only process the pull requests that does not contain one of these milestone(s). +It can be a comma separated list of milestones (e.g: `V1,next`). + +If unset (or an empty string), this option will not alter the stale workflow. + +Default value: unset + +#### exempt-all-pr-milestones + +If set to `true`, the pull requests with a milestone will not be marked as stale automatically. + +Priority over [exempt-pr-milestones](#exempt-pr-milestones). + +Default value: `false` + +#### exempt-pr-assignees + +An allow-list of assignee(s) to only process the pull requests that does not contain one of these assignee(s). +It can be a comma separated list of assignees (e.g: `marco,polo`). + +If unset (or an empty string), this option will not alter the stale workflow. + +Default value: unset + #### exempt-all-pr-assignees If set to `true`, the pull requests with an assignee will not be marked as stale automatically. @@ -455,22 +475,6 @@ If set to `true`, the pull requests currently in draft will not be marked as sta Default value: `false` Required Permission: `pull-requests: read` -#### enable-statistics - -Collects and display statistics at the end of the stale workflow logs to get a summary of what happened during the run. -This option is only useful if the debug output secret `ACTIONS_STEP_DEBUG` is set to `true` in your repository to display the logs. - -Default value: `true` - -#### ignore-issue-updates - -The option [days-before-stale](#days-before-stale) will define the number of days before considering the issues or the pull requests as stale. -In most cases, the purpose of this action is to only stale when necessary so if any update occurs or if a comment is added to them, the counter will restart. -Nonetheless, if you don't care about this, and you prefer to stick to this number of days no matter the update, you can enable this option. -Instead of comparing the number of days based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `updated_at`, it will be based on the [GitHub issue](https://docs.github.com/en/rest/reference/issues) field `created_at`. - -Default value: `false` - #### ignore-pr-updates In most cases, the purpose of this action is to only stale when necessary so if any update occurs or if a comment is added to them, the counter will restart.