stale/action.yml

199 lines
10 KiB
YAML
Raw Normal View History

2019-08-04 09:34:59 +08:00
name: 'Close Stale Issues'
2019-11-09 00:47:32 +08:00
description: 'Close issues and pull requests with no recent activity'
2019-08-04 09:34:59 +08:00
author: 'GitHub'
inputs:
2019-08-07 04:25:08 +08:00
repo-token:
description: 'Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.'
required: false
default: ${{ github.token }}
2019-08-07 04:25:08 +08:00
stale-issue-message:
description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.'
required: false
2019-08-07 04:25:08 +08:00
stale-pr-message:
description: 'The message to post on the pull request when tagging it. If none provided, will not mark pull requests stale.'
required: false
close-issue-message:
description: 'The message to post on the issue when closing it. If none provided, will not comment when closing an issue.'
required: false
close-pr-message:
description: 'The message to post on the pull request when closing it. If none provided, will not comment when closing a pull requests.'
required: false
2019-08-07 04:25:08 +08:00
days-before-stale:
description: 'The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.'
required: false
default: '60'
days-before-issue-stale:
description: 'The number of days old an issue can be before marking it stale. Set to -1 to never mark issues as stale automatically. Override "days-before-stale" option regarding only the issues.'
required: false
days-before-pr-stale:
description: 'The number of days old a pull request can be before marking it stale. Set to -1 to never mark pull requests as stale automatically. Override "days-before-stale" option regarding only the pull requests.'
required: false
2019-08-07 04:25:08 +08:00
days-before-close:
description: 'The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.'
required: false
default: '7'
days-before-issue-close:
description: 'The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.'
required: false
days-before-pr-close:
description: 'The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.'
required: false
2019-08-07 04:25:08 +08:00
stale-issue-label:
description: 'The label to apply when an issue is stale.'
required: false
2019-08-07 04:25:08 +08:00
default: 'Stale'
close-issue-label:
description: 'The label to apply when an issue is closed.'
required: false
exempt-issue-labels:
description: 'The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").'
default: ''
required: false
2019-08-07 04:25:08 +08:00
stale-pr-label:
description: 'The label to apply when a pull request is stale.'
2019-08-07 04:25:08 +08:00
default: 'Stale'
required: false
close-pr-label:
description: 'The label to apply when a pull request is closed.'
required: false
exempt-pr-labels:
description: 'The labels that mean a pull request is exempt from being marked as stale. Separate multiple labels with commas (eg. "label1,label2").'
default: ''
required: false
exempt-milestones:
description: 'The milestones that mean an issue or a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2").'
default: ''
required: false
exempt-issue-milestones:
description: 'The milestones that mean an issue is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the issues.'
default: ''
required: false
exempt-pr-milestones:
description: 'The milestones that mean a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the pull requests.'
default: ''
required: false
exempt-all-milestones:
description: 'Exempt all issues and pull requests with milestones from being marked as stale. Default to false.'
default: 'false'
required: false
exempt-all-issue-milestones:
description: 'Exempt all issues with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the issues.'
default: ''
required: false
exempt-all-pr-milestones:
description: 'Exempt all pull requests with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the pull requests.'
default: ''
required: false
2019-09-27 21:33:20 +08:00
only-labels:
description: 'Only issues or pull requests with all of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.'
default: ''
required: false
any-of-labels:
description: 'Only issues or pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.'
2019-09-27 21:33:20 +08:00
default: ''
required: false
feat(any-of-labels): add 2 new options to customize for issues/PRs (#380) * docs(only-labels): enhance the docs and fix duplicate (#341) * docs(only-labels): remove duplicated option and improve descriptions a bad rebase happend * docs(readme): use a multi-line array and remove the optional column the option column was not helpful since each value is optional the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width * style(readme): break line for the statistics * docs(readme): add a better description for the ascending option * docs(action): add missing punctuation * build(deps-dev): bump @typescript-eslint/eslint-plugin (#342) Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350) Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#15) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#17) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#18) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat(any-of-labels): add 2 new options to customize for issues/PRs closes #371 change this option and only-labels to have tree-logs * chore(index): update it Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-29 04:33:42 +08:00
any-of-issue-labels:
description: 'Only issues with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the issues.'
default: ''
required: false
any-of-pr-labels:
description: 'Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.'
default: ''
required: false
only-issue-labels:
description: 'Only issues with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the issues.'
default: ''
required: false
only-pr-labels:
description: 'Only pull requests with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the pull requests.'
default: ''
required: false
2019-08-07 04:25:08 +08:00
operations-per-run:
description: 'The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).'
default: '30'
required: false
remove-stale-when-updated:
description: 'Remove stale labels from issues and pull requests when they are updated or commented on.'
feat(remove-stale-when-updated): add 2 options for issues and prs (#383) * docs(only-labels): enhance the docs and fix duplicate (#341) * docs(only-labels): remove duplicated option and improve descriptions a bad rebase happend * docs(readme): use a multi-line array and remove the optional column the option column was not helpful since each value is optional the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width * style(readme): break line for the statistics * docs(readme): add a better description for the ascending option * docs(action): add missing punctuation * build(deps-dev): bump @typescript-eslint/eslint-plugin (#342) Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350) Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#15) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#17) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#18) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat(remove-stale-when-updated): add 2 options for issues and prs closes #377 also I closed the stale process once the stale label is removed since the following process is regarding the closing and it should simply not occur if no longer stale * chore(logs): add more logs to understand the process * chore(logs): highlights more logs and humanize a bit more * chore(index): update it * refactor(checks): simplify if complexity Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-30 21:14:51 +08:00
default: 'true'
required: false
remove-issue-stale-when-updated:
description: 'Remove stale labels from issues when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the issues.'
docs(overhaul): provide a very detailed documentation for the options (#456) * docs: add doc for repo-token and fix a bunch of typo * docs: add doc for days-before-stale Closes #362 * docs: add doc for days-before-issue-stale Closes #362 * docs: add doc for days-before-pr-stale Closes #362 * docs: add doc for days-before-close options Closes #362 * docs: add doc for stale-message options Closes #362 * docs: add doc for close-message options Closes #362 * docs: add doc for label options Closes #362 * docs: add doc for exempt label options Closes #362 * docs: add doc for only labels options Closes #362 * docs: add doc for any of labels options Closes #362 * docs: add doc for enable-statistics option Closes #362 * docs: add doc for exempt milestones options Closes #362 * docs: add doc for exempt all milestones options Closes #362 * docs: add doc for assignees options Closes #362 * docs: add doc for remove-stale-when-updated options Closes #362 * docs: add doc for debug-only option Closes #362 * docs: add doc for ascending option Closes #362 * docs: add doc for skip-stale-message options Closes #362 * docs: add doc for start-date option Closes #362 * docs: add doc for delete-branch option Closes #362 * docs: remove duplicated row * docs: shorten the description in the array * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * docs(readme): add more information for days-before-stale option * docs(readme): apply suggestion * docs(readme): remove duplicated entry nice catch @luketomlinson Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2021-05-26 01:25:52 +08:00
default: ''
feat(remove-stale-when-updated): add 2 options for issues and prs (#383) * docs(only-labels): enhance the docs and fix duplicate (#341) * docs(only-labels): remove duplicated option and improve descriptions a bad rebase happend * docs(readme): use a multi-line array and remove the optional column the option column was not helpful since each value is optional the multi-line array will allow to have a better UI in small devices and basically in GitHub too due to the max-width * style(readme): break line for the statistics * docs(readme): add a better description for the ascending option * docs(action): add missing punctuation * build(deps-dev): bump @typescript-eslint/eslint-plugin (#342) Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 4.15.2 to 4.16.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v4.16.1/packages/eslint-plugin) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump @octokit/rest from 18.3.0 to 18.3.2 (#350) Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.3.0 to 18.3.2. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](https://github.com/octokit/rest.js/compare/v18.3.0...v18.3.2) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#15) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#17) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: add more coverage for the stale label behaviour (#352) (#18) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat(remove-stale-when-updated): add 2 options for issues and prs closes #377 also I closed the stale process once the stale label is removed since the following process is regarding the closing and it should simply not occur if no longer stale * chore(logs): add more logs to understand the process * chore(logs): highlights more logs and humanize a bit more * chore(index): update it * refactor(checks): simplify if complexity Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-30 21:14:51 +08:00
required: false
remove-pr-stale-when-updated:
description: 'Remove stale labels from pull requests when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the pull requests.'
docs(overhaul): provide a very detailed documentation for the options (#456) * docs: add doc for repo-token and fix a bunch of typo * docs: add doc for days-before-stale Closes #362 * docs: add doc for days-before-issue-stale Closes #362 * docs: add doc for days-before-pr-stale Closes #362 * docs: add doc for days-before-close options Closes #362 * docs: add doc for stale-message options Closes #362 * docs: add doc for close-message options Closes #362 * docs: add doc for label options Closes #362 * docs: add doc for exempt label options Closes #362 * docs: add doc for only labels options Closes #362 * docs: add doc for any of labels options Closes #362 * docs: add doc for enable-statistics option Closes #362 * docs: add doc for exempt milestones options Closes #362 * docs: add doc for exempt all milestones options Closes #362 * docs: add doc for assignees options Closes #362 * docs: add doc for remove-stale-when-updated options Closes #362 * docs: add doc for debug-only option Closes #362 * docs: add doc for ascending option Closes #362 * docs: add doc for skip-stale-message options Closes #362 * docs: add doc for start-date option Closes #362 * docs: add doc for delete-branch option Closes #362 * docs: remove duplicated row * docs: shorten the description in the array * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * docs(readme): apply suggestion Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * chore(readme): enhance typo * docs(readme): add more information for days-before-stale option * docs(readme): apply suggestion * docs(readme): remove duplicated entry nice catch @luketomlinson Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2021-05-26 01:25:52 +08:00
default: ''
required: false
debug-only:
description: 'Run the processor in debug mode without actually performing any operations on live issues.'
default: 'false'
required: false
ascending:
description: 'The order to get issues or pull requests. Defaults to false, which is descending.'
default: 'false'
required: false
delete-branch:
description: 'Delete the git branch after closing a stale pull request.'
default: 'false'
required: false
start-date:
description: 'The date used to skip the stale action on issue/pull request created before it (ISO 8601 or RFC 2822).'
default: ''
required: false
exempt-assignees:
description: 'The assignees which exempt an issue or a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2").'
default: ''
required: false
exempt-issue-assignees:
description: 'The assignees which exempt an issue from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the issues.'
default: ''
required: false
exempt-pr-assignees:
description: 'The assignees which exempt a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the pull requests.'
default: ''
required: false
exempt-all-assignees:
description: 'Exempt all issues and pull requests with assignees from being marked as stale. Default to false.'
default: 'false'
required: false
exempt-all-issue-assignees:
description: 'Exempt all issues with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the issues.'
default: ''
required: false
exempt-all-pr-assignees:
description: 'Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.'
default: ''
required: false
exempt-draft-pr:
description: 'Exempt draft pull requests from being marked as stale. Default to false.'
default: 'false'
required: false
enable-statistics:
description: 'Display some statistics at the end regarding the stale workflow (only when the logs are enabled).'
default: 'true'
required: false
labels-to-add-when-unstale:
description: 'A comma delimited list of labels to add when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
default: ''
required: false
labels-to-remove-when-unstale:
description: 'A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.'
default: ''
required: false
ignore-issue-updates:
description: 'Any update (update/comment) can reset the stale idle time on the issues.'
default: 'false'
required: false
ignore-pr-updates:
description: 'Any update (update/comment) can reset the stale idle time on the pull requests.'
default: 'false'
required: false
outputs:
closed-issues-prs:
description: 'List of all closed issues and pull requests.'
staled-issues-prs:
description: 'List of all staled issues and pull requests.'
2019-08-04 09:34:59 +08:00
runs:
using: 'node12'
main: 'dist/index.js'