Files
probot.github.io/_apps/lock.md
Brandon Keepers a2bb4b2af8 Sync data
2019-01-18 22:05:32 +00:00

84 lines
2.2 KiB
Markdown

---
title: Lock Threads
description: Locks closed issues and pull requests after a period of inactivity.
slug: lock
screenshots:
- https://raw.githubusercontent.com/dessant/lock-threads/master/assets/screenshot.png
authors:
- dessant
repository: dessant/lock-threads
host: https://probot-lock-threads.glitch.me
stars: 63
updated: 2019-01-18 12:02:12 UTC
installations: 198
organizations:
- facebook
- Microsoft
- ReactiveX
- zeit
- jquery
- ethereum
- Homebrew
- atom
- mozilla
- babel
---
A GitHub App that locks closed issues and pull requests after
a period of inactivity.
## Usage
1. **[Install the GitHub App](https://github.com/apps/lock)**
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:
```yaml
# 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
# 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
```
## 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](https://www.patreon.com/dessant).