87 lines
2.1 KiB
Markdown
87 lines
2.1 KiB
Markdown
|
# Close Stale Issues and PRs
|
||
|
|
|
||
|
|
Warns and then closes issues and PRs that have had no activity for a specified amount of time.
|
||
|
|
|
||
|
|
### Building and testing
|
||
|
|
|
||
|
|
Install the dependencies
|
||
|
|
```bash
|
||
|
|
$ npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Build the typescript and package it for distribution
|
||
|
|
```bash
|
||
|
|
$ npm run build && npm run pack
|
||
|
|
```
|
||
|
|
|
||
|
|
Run the tests :heavy_check_mark:
|
||
|
|
```bash
|
||
|
|
$ npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
### Usage
|
||
|
|
|
||
|
|
See [action.yml](./action.yml) For comprehensive list of options.
|
||
|
|
|
||
|
|
Basic:
|
||
|
|
```yaml
|
||
|
|
name: "Close stale issues"
|
||
|
|
on:
|
||
|
|
schedule:
|
||
|
|
- cron: "0 0 * * *"
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
stale:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/[email protected]
|
||
|
|
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:
|
||
|
|
```yaml
|
||
|
|
name: "Close stale issues"
|
||
|
|
on:
|
||
|
|
schedule:
|
||
|
|
- cron: "0 0 * * *"
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
stale:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/[email protected]
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
Configure labels:
|
||
|
|
```yaml
|
||
|
|
name: "Close stale issues"
|
||
|
|
on:
|
||
|
|
schedule:
|
||
|
|
- cron: "0 0 * * *"
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
stale:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/[email protected]
|
||
|
|
with:
|
||
|
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||
|
|
stale-issue-message: 'Stale issue message'
|
||
|
|
stale-pr-message: 'Stale issue message'
|
||
|
|
stale-issue-label: 'no-issue-activity'
|
||
|
|
exempt-issue-labels: 'awaiting-approval,work-in-progress'
|
||
|
|
stale-pr-label: 'no-pr-activity'
|
||
|
|
exempt-pr-labels: 'awaiting-approval,work-in-progress'
|
||
|
|
```
|
||
|
|
|
||
|
|
### Debugging
|
||
|
|
|
||
|
|
To see debug ouput from this action, you must set the secret `ACTIONS_STEP_DEBUG` to `true` in your repository. You can run this action in debug only mode (no actions will be taken on your issues) by passing `debug-only` `true` as an argument to the action.
|