🤖 GitHub App that locks closed issues and pull requests after a period of inactivity
Clone or download
Latest commit 3817dc6 Nov 8, 2018

README.md

Lock Threads

Build Status Version

Lock Threads is a GitHub App inspired by Stale and built with Probot that locks closed issues and pull requests after a period of inactivity.

Supporting the Project

The continued development of Lock Threads is made possible thanks to the support of awesome backers. If you'd like to join them, please consider contributing with Patreon, PayPal or Bitcoin.

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

Configuration

Create .github/lock.yml in the default branch to enable the app. The file can be empty, or it can override any of these default settings:

# Configuration for lock-threads - https://github.com/dessant/lock-threads

# 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 not be locked. 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 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 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 locked?

To avoid triggering abuse prevention mechanisms on GitHub, only 30 issues and pull requests will be locked per hour. If your repository has more than that, it will just take a few hours or days to lock them all.

Deployment

See docs/deploy.md if you would like to run your own instance of this app.

License

Lock Threads is released under the terms of the MIT License. Please refer to the LICENSE file.