stale/README.md

65 lines
1.5 KiB
Markdown
Raw Normal View History

2019-08-07 04:25:08 +08:00
# Close Stale Issues and PRs
2019-08-04 09:34:59 +08:00
2019-08-07 04:25:08 +08:00
Warns and then closes issues and PRs that have had no activity for a specified amount of time.
### Usage
See [action.yml](./action.yml) For comprehensive list of options.
2019-08-04 09:34:59 +08:00
2019-08-07 04:25:08 +08:00
Basic:
```
name: "Close stale issues"
on:
schedule:
2019-08-07 05:51:08 +08:00
- cron: "0 * * * *"
2019-08-07 04:25:08 +08:00
jobs:
stale:
runs-on: ubuntu-latest
steps:
2019-08-07 05:44:47 +08:00
- uses: actions/stale@v1
2019-08-07 04:25:08 +08:00
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'Message to comment on stale issues. If none provided, will not mark issues stale'
stale-pr-message: 'Message to comment on stale PRs. If none provided, will not mark PRs stale'
```
Configure stale timeouts:
```
name: "Close stale issues"
on:
schedule:
2019-08-07 05:51:08 +08:00
- cron: "0 * * * *"
2019-08-07 04:25:08 +08:00
jobs:
stale:
runs-on: ubuntu-latest
steps:
2019-08-07 05:44:47 +08:00
- uses: actions/stale@v1
2019-08-07 04:25:08 +08:00
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'
days-before-stale: 30
days-before-close: 5
```
2019-08-04 09:34:59 +08:00
2019-08-07 04:25:08 +08:00
Configure labels:
2019-08-04 09:34:59 +08:00
```
name: "Close stale issues"
on:
schedule:
2019-08-07 05:51:08 +08:00
- cron: "0 * * * *"
2019-08-04 09:34:59 +08:00
jobs:
2019-08-07 04:25:08 +08:00
stale:
2019-08-04 09:34:59 +08:00
runs-on: ubuntu-latest
steps:
2019-08-07 05:44:47 +08:00
- uses: actions/stale@v1
2019-08-04 09:34:59 +08:00
with:
2019-08-07 04:25:08 +08:00
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'Stale issue message'
stale-pr-message: 'Stale issue message'
stale-issue-label: 'no-issue-activity'
stale-pr-label: 'no-pr-activity'
2019-08-04 09:34:59 +08:00
```