Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dessant/lock-threads-app
🤖 GitHub App that locks closed issues and pull requests after a period of inactivity
https://github.com/dessant/lock-threads-app
github-app issues lock probot probot-app pull-requests
Last synced: about 1 month ago
JSON representation
🤖 GitHub App that locks closed issues and pull requests after a period of inactivity
- Host: GitHub
- URL: https://github.com/dessant/lock-threads-app
- Owner: dessant
- License: mit
- Archived: true
- Created: 2020-02-16T15:08:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-03T16:13:31.000Z (over 3 years ago)
- Last Synced: 2024-09-24T09:03:25.306Z (about 1 month ago)
- Topics: github-app, issues, lock, probot, probot-app, pull-requests
- Language: JavaScript
- Homepage:
- Size: 220 KB
- Stars: 15
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Lock Threads
[](https://www.npmjs.com/package/lock-threads)
> This project is no longer maintained, please migrate to [Lock Threads](https://github.com/dessant/lock-threads).
Lock Threads is a GitHub App inspired by [Stale](https://github.com/probot/stale)
and built with [Probot](https://github.com/probot/probot)
that locks closed issues and pull requests after a period of inactivity.
## Usage
1. **[Install the GitHub App]()**
for the intended repositories
2. Create `.github/lock.yml` based on the template below
3. It will start scanning for closed issues and/or pull requests within an hour
**If possible, install the app only for select repositories.
Do not leave the `All repositories` option selected, unless you intend
to use the app for all current and future repositories.**
#### Configuration
Create `.github/lock.yml` in the default branch to enable the app,
or add it at the same file path to a repository named `.github`.
The file can be empty, or it can override any of these default settings:
```yaml
# Configuration for Lock Threads - https://github.com/dessant/lock-threads-app
# Number of days of inactivity before a closed issue or pull request is locked
daysUntilLock: 365
# Skip issues and pull requests created before a given timestamp. Timestamp must
# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
skipCreatedBefore: false
# Issues and pull requests with these labels will be ignored. Set to `[]` to disable
exemptLabels: []
# Label to add before locking, such as `outdated`. Set to `false` to disable
lockLabel: false
# Comment to post before locking. Set to `false` to disable
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.
# Assign `resolved` as the reason for locking. Set to `false` to disable
setLockReason: true
# Limit to only `issues` or `pulls`
# only: issues
# Optionally, specify configuration settings just for `issues` or `pulls`
# issues:
# exemptLabels:
# - help-wanted
# lockLabel: outdated
# pulls:
# daysUntilLock: 30
# Repository to extend settings from
# _extends: repo
```
## How are issues and pull requests determined to be inactive?
The app uses GitHub's [updated](https://git.io/fhRnE) search qualifier
to determine inactivity. Any change to an issue or pull request
is considered an update, including comments, changing labels,
applying or removing milestones, or pushing commits.
An easy way to check and see which issues or pull requests will initially
be locked is to add the `updated` search qualifier to either the issue
or pull request page filter for your repository:
`is:closed is:unlocked updated:<2016-12-20`.
Adjust the date to be 365 days ago (or whatever you set for `daysUntilLock`)
to see which issues or pull requests will be locked.
## Why are only some issues and pull requests processed?
To avoid triggering abuse prevention mechanisms on GitHub, only 30 issues
and pull requests will be handled per hour. If your repository has more
than that, it will just take a few hours or days to process them all.
## Deployment
See [docs/deploy.md](docs/deploy.md) if you would like to run your own
instance of this app.
## License
Copyright (c) 2017-2021 Armin Sebastian
This software is released under the terms of the MIT License.
See the [LICENSE](LICENSE) file for further information.