GitHub Action
Lock Threads
Lock Threads is a GitHub Action that locks closed issues, pull requests and discussions after a period of inactivity.
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.
Create the lock-threads.yml
workflow file in the .github/workflows
directory, use one of the example workflows to get started.
The action can be configured using input parameters.
github-token
- GitHub access token, value must be
${{ github.token }}
or an encrypted secret that contains a personal access token - Optional, defaults to
${{ github.token }}
- GitHub access token, value must be
issue-inactive-days
- Number of days of inactivity before a closed issue is locked
- Optional, defaults to
365
exclude-issue-created-before
- Do not lock issues created before a given date,
value must follow ISO 8601, ignored
when
exclude-issue-created-between
is set - Optional, defaults to
''
- Do not lock issues created before a given date,
value must follow ISO 8601, ignored
when
exclude-issue-created-after
- Do not lock issues created after a given date,
value must follow ISO 8601, ignored
when
exclude-issue-created-between
is set - Optional, defaults to
''
- Do not lock issues created after a given date,
value must follow ISO 8601, ignored
when
exclude-issue-created-between
- Do not lock issues created in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
exclude-issue-closed-before
- Do not lock issues closed before a given date,
value must follow ISO 8601, ignored
when
exclude-issue-closed-between
is set - Optional, defaults to
''
- Do not lock issues closed before a given date,
value must follow ISO 8601, ignored
when
exclude-issue-closed-after
- Do not lock issues closed after a given date,
value must follow ISO 8601, ignored
when
exclude-issue-closed-between
is set - Optional, defaults to
''
- Do not lock issues closed after a given date,
value must follow ISO 8601, ignored
when
exclude-issue-closed-between
- Do not lock issues closed in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
include-any-issue-labels
- Only lock issues with any of these labels, value must be
a comma separated list of labels or
''
, ignored wheninclude-all-issue-labels
is set - Optional, defaults to
''
- Only lock issues with any of these labels, value must be
a comma separated list of labels or
include-all-issue-labels
- Only lock issues with all these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Only lock issues with all these labels, value must be
a comma separated list of labels or
exclude-any-issue-labels
- Do not lock issues with any of these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Do not lock issues with any of these labels, value must be
a comma separated list of labels or
add-issue-labels
- Labels to add before locking an issue, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to add before locking an issue, value must be
a comma separated list of labels or
remove-issue-labels
- Labels to remove before locking an issue, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to remove before locking an issue, value must be
a comma separated list of labels or
issue-comment
- Comment to post before locking an issue
- Optional, defaults to
''
issue-lock-reason
- Reason for locking an issue, value must be one
of
resolved
,off-topic
,too heated
,spam
or''
- Optional, defaults to
resolved
- Reason for locking an issue, value must be one
of
pr-inactive-days
- Number of days of inactivity before a closed pull request is locked
- Optional, defaults to
365
exclude-pr-created-before
- Do not lock pull requests created before a given date,
value must follow ISO 8601, ignored
when
exclude-pr-created-between
is set - Optional, defaults to
''
- Do not lock pull requests created before a given date,
value must follow ISO 8601, ignored
when
exclude-pr-created-after
- Do not lock pull requests created after a given date,
value must follow ISO 8601, ignored
when
exclude-pr-created-between
is set - Optional, defaults to
''
- Do not lock pull requests created after a given date,
value must follow ISO 8601, ignored
when
exclude-pr-created-between
- Do not lock pull requests created in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
exclude-pr-closed-before
- Do not lock pull requests closed before a given date,
value must follow ISO 8601, ignored
when
exclude-pr-closed-between
is set - Optional, defaults to
''
- Do not lock pull requests closed before a given date,
value must follow ISO 8601, ignored
when
exclude-pr-closed-after
- Do not lock pull requests closed after a given date,
value must follow ISO 8601, ignored
when
exclude-pr-closed-between
is set - Optional, defaults to
''
- Do not lock pull requests closed after a given date,
value must follow ISO 8601, ignored
when
exclude-pr-closed-between
- Do not lock pull requests closed in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
include-any-pr-labels
- Only lock pull requests with any of these labels, value must be
a comma separated list of labels or
''
, ignored wheninclude-all-pr-labels
is set - Optional, defaults to
''
- Only lock pull requests with any of these labels, value must be
a comma separated list of labels or
include-all-pr-labels
- Only lock pull requests with all these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Only lock pull requests with all these labels, value must be
a comma separated list of labels or
exclude-any-pr-labels
- Do not lock pull requests with any of these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Do not lock pull requests with any of these labels, value must be
a comma separated list of labels or
add-pr-labels
- Labels to add before locking a pull request, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to add before locking a pull request, value must be
a comma separated list of labels or
remove-pr-labels
- Labels to remove before locking a pull request, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to remove before locking a pull request, value must be
a comma separated list of labels or
pr-comment
- Comment to post before locking a pull request
- Optional, defaults to
''
pr-lock-reason
- Reason for locking a pull request, value must be one
of
resolved
,off-topic
,too heated
,spam
or''
- Optional, defaults to
resolved
- Reason for locking a pull request, value must be one
of
discussion-inactive-days
- Number of days of inactivity before a closed discussion is locked
- Optional, defaults to
365
exclude-discussion-created-before
- Do not lock discussions created before a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-created-between
is set - Optional, defaults to
''
- Do not lock discussions created before a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-created-after
- Do not lock discussions created after a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-created-between
is set - Optional, defaults to
''
- Do not lock discussions created after a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-created-between
- Do not lock discussions created in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
exclude-discussion-closed-before
- Do not lock discussions closed before a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-closed-between
is set - Optional, defaults to
''
- Do not lock discussions closed before a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-closed-after
- Do not lock discussions closed after a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-closed-between
is set - Optional, defaults to
''
- Do not lock discussions closed after a given date,
value must follow ISO 8601, ignored
when
exclude-discussion-closed-between
- Do not lock discussions closed in a given time interval, value must follow ISO 8601
- Optional, defaults to
''
include-any-discussion-labels
- Only lock discussions with any of these labels, value must be
a comma separated list of labels or
''
, ignored wheninclude-all-discussion-labels
is set - Optional, defaults to
''
- Only lock discussions with any of these labels, value must be
a comma separated list of labels or
include-all-discussion-labels
- Only lock discussions with all these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Only lock discussions with all these labels, value must be
a comma separated list of labels or
exclude-any-discussion-labels
- Do not lock discussions with any of these labels, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Do not lock discussions with any of these labels, value must be
a comma separated list of labels or
add-discussion-labels
- Labels to add before locking a discussion, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to add before locking a discussion, value must be
a comma separated list of labels or
remove-discussion-labels
- Labels to remove before locking a discussion, value must be
a comma separated list of labels or
''
- Optional, defaults to
''
- Labels to remove before locking a discussion, value must be
a comma separated list of labels or
discussion-comment
- Comment to post before locking a discussion
- Optional, defaults to
''
process-only
- Only lock issues, pull requests or discussions,
value must be a comma separated list, list items must be
one of
issues
,prs
ordiscussions
- Optional, defaults to
''
- Only lock issues, pull requests or discussions,
value must be a comma separated list, list items must be
one of
log-output
- Log output parameters, value must be either
true
orfalse
- Optional, defaults to
false
- Log output parameters, value must be either
issues
- Issues that have been locked, value is a JSON string in the form
of
[{"owner": "actions", "repo": "toolkit", "issue_number": 1}]
- Defaults to
''
- Issues that have been locked, value is a JSON string in the form
of
prs
- Pull requests that have been locked, value is a JSON string in the form
of
[{"owner": "actions", "repo": "toolkit", "issue_number": 1}]
- Defaults to
''
- Pull requests that have been locked, value is a JSON string in the form
of
discussions
- Discussions that have been locked, value is a JSON string in the form
of
[{"owner": "actions", "repo": "toolkit", "discussion_number": 1}]
- Defaults to
''
- Discussions that have been locked, value is a JSON string in the form
of
The following workflow will search once an hour for closed issues, pull requests and discussions that have not had any activity in the past year and can be locked.
name: 'Lock Threads'
on:
schedule:
- cron: '0 * * * *'
workflow_dispatch:
permissions:
issues: write
pull-requests: write
discussions: write
concurrency:
group: lock-threads
jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
Edit the workflow after the initial backlog of issues, pull requests and discussions has been processed to reduce the frequency of scheduled runs. Running the workflow only once a day helps reduce resource usage.
on:
schedule:
- cron: '0 0 * * *'
This workflow declares all the available input parameters of the action and their default values. Any of the parameters can be omitted.
name: 'Lock Threads'
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
permissions:
issues: write
pull-requests: write
discussions: write
concurrency:
group: lock-threads
jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
with:
github-token: ${{ github.token }}
issue-inactive-days: '365'
exclude-issue-created-before: ''
exclude-issue-created-after: ''
exclude-issue-created-between: ''
exclude-issue-closed-before: ''
exclude-issue-closed-after: ''
exclude-issue-closed-between: ''
include-any-issue-labels: ''
include-all-issue-labels: ''
exclude-any-issue-labels: ''
add-issue-labels: ''
remove-issue-labels: ''
issue-comment: ''
issue-lock-reason: 'resolved'
pr-inactive-days: '365'
exclude-pr-created-before: ''
exclude-pr-created-after: ''
exclude-pr-created-between: ''
exclude-pr-closed-before: ''
exclude-pr-closed-after: ''
exclude-pr-closed-between: ''
include-any-pr-labels: ''
include-all-pr-labels: ''
exclude-any-pr-labels: ''
add-pr-labels: ''
remove-pr-labels: ''
pr-comment: ''
pr-lock-reason: 'resolved'
discussion-inactive-days: '365'
exclude-discussion-created-before: ''
exclude-discussion-created-after: ''
exclude-discussion-created-between: ''
exclude-discussion-closed-before: ''
exclude-discussion-closed-after: ''
exclude-discussion-closed-between: ''
include-any-discussion-labels: ''
include-all-discussion-labels: ''
exclude-any-discussion-labels: ''
add-discussion-labels: ''
remove-discussion-labels: ''
discussion-comment: ''
process-only: ''
log-output: false
This step will lock only issues, and exclude issues created before 2018,
or those with the upstream
or help-wanted
labels applied.
steps:
- uses: dessant/lock-threads@v5
with:
exclude-issue-created-before: '2018-01-01T00:00:00Z'
exclude-any-issue-labels: 'upstream, help-wanted'
process-only: 'issues'
This step will lock only pull requests, and exclude those
with the wip
label applied.
steps:
- uses: dessant/lock-threads@v5
with:
exclude-any-pr-labels: 'wip'
process-only: 'prs'
This step will lock only issues, and exclude issues closed before 2018, or those created in 2018 and 2019.
steps:
- uses: dessant/lock-threads@v5
with:
exclude-issue-created-between: '2018-01-01T00:00:00Z/2019-12-31T23:59:59.999Z'
exclude-issue-closed-before: '2018-01-01T00:00:00Z'
process-only: 'issues'
This step will lock issues that have the incomplete
or invalid
labels applied, and pull requests that have the qa: done
and published
labels applied.
steps:
- uses: dessant/lock-threads@v5
with:
include-any-issue-labels: 'incomplete, invalid'
include-all-pr-labels: 'qa: done, published'
process-only: 'issues, prs'
This step will lock discussions that have not had any activity in the past 180 days.
steps:
- uses: dessant/lock-threads@v5
with:
discussion-inactive-days: '180'
process-only: 'discussions'
This step will post a comment on issues and pull requests before locking them,
and apply the outdated
label to issues.
steps:
- uses: dessant/lock-threads@v5
with:
add-issue-labels: 'outdated'
issue-comment: >
This issue has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new issue for related bugs.
pr-comment: >
This pull request has been automatically locked since there
has not been any recent activity after it was closed.
Please open a new issue for related bugs.
process-only: 'issues, prs'
This step will apply the qa: done
and archived
labels,
and remove the qa: primary
and needs: user feedback
labels
before locking issues.
steps:
- uses: dessant/lock-threads@v5
with:
add-issue-labels: 'qa: done, archived'
remove-issue-labels: 'qa: primary, needs: user feedback'
process-only: 'issues'
The action uses an installation access token by default to interact with GitHub.
You may also authenticate with a personal access token to perform actions
as a GitHub user instead of the github-actions
app.
Create a personal access token
with the repo
or public_repo
scopes enabled, and add the token as an
encrypted secret
for the repository or organization, then provide the action with the secret
using the github-token
input parameter.
steps:
- uses: dessant/lock-threads@v5
with:
github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
The action uses GitHub's updated search qualifier to determine inactivity. Any change to an issue, pull request or discussion is considered an update, including new comments, or changing labels.
An easy way to see which threads will initially be locked is to add
the updated
search qualifier to the issue, pull request or discussion
search field for your repository, adjust the date based on the value
of the *-inactive-days
input parameter:
is:closed is:unlocked updated:<2018-12-20
.
To avoid triggering abuse prevention mechanisms on GitHub, only 50 threads will be handled at a time. If your repository has more than that, it will take a few hours or days to process them all.
Copyright (c) 2017-2023 Armin Sebastian
This software is released under the terms of the MIT License. See the LICENSE file for further information.