Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/dessant/lock-threads

GitHub Action that locks closed issues, pull requests and discussions after a period of inactivity
https://github.com/dessant/lock-threads

github-actions issues lock pull-requests

Last synced: 12 days ago
JSON representation

GitHub Action that locks closed issues, pull requests and discussions after a period of inactivity

Lists

README 

        
# Lock Threads



Lock Threads is a GitHub Action that locks closed issues,

pull requests and discussions 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](https://armin.dev/go/patreon?pr=lock-threads&src=repo),

[PayPal](https://armin.dev/go/paypal?pr=lock-threads&src=repo) or

[Bitcoin](https://armin.dev/go/bitcoin?pr=lock-threads&src=repo).



## Usage



Create the `lock-threads.yml` workflow file in the `.github/workflows`

directory, use one of the [example workflows](#examples) to get started.



### Inputs



The action can be configured using [input parameters](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith).



- **`github-token`**

  - GitHub access token, value must be `${{ github.token }}` or an encrypted

    secret that contains a [personal access token](#using-a-personal-access-token)

  - Optional, defaults to `${{ github.token }}`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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

    when `include-all-issue-labels` is set

  - Optional, defaults to `''`

- **`include-all-issue-labels`**

  - Only lock issues with all these labels, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`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 `''`

- **`add-issue-labels`**

  - Labels to add before locking an issue, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`remove-issue-labels`**

  - Labels to remove before locking an issue, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`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`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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

    when `include-all-pr-labels` is set

  - Optional, defaults to `''`

- **`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 `''`

- **`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 `''`

- **`add-pr-labels`**

  - Labels to add before locking a pull request, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`remove-pr-labels`**

  - Labels to remove before locking a pull request, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`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`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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 `''`

- **`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

    when `include-all-discussion-labels` is set

  - Optional, defaults to `''`

- **`include-all-discussion-labels`**

  - Only lock discussions with all these labels, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`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 `''`

- **`add-discussion-labels`**

  - Labels to add before locking a discussion, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`remove-discussion-labels`**

  - Labels to remove before locking a discussion, value must be

    a comma separated list of labels or `''`

  - Optional, defaults to `''`

- **`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` or `discussions`

  - Optional, defaults to `''`

- **`log-output`**

  - Log output parameters, value must be either `true` or `false`

  - Optional, defaults to `false`



### Outputs



- **`issues`**

  - Issues that have been locked, value is a JSON string in the form

    of `[{"owner": "actions", "repo": "toolkit", "issue_number": 1}]`

  - Defaults to `''`

- **`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 `''`

- **`discussions`**

  - Discussions that have been locked, value is a JSON string in the form

    of `[{"owner": "actions", "repo": "toolkit", "discussion_number": 1}]`

  - Defaults to `''`



## Examples



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.



```yaml

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.



```yaml

on:

  schedule:

    - cron: '0 0 * * *'

```



### Available input parameters



This workflow declares all the available input parameters of the action

and their default values. Any of the parameters can be omitted.



```yaml

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

```



### Filtering issues, pull requests and discussions



This step will lock only issues, and exclude issues created before 2018,

or those with the `help wanted` or `upstream` labels applied.



```yaml

    steps:

      - uses: dessant/lock-threads@v5

        with:

          exclude-issue-created-before: '2018-01-01T00:00:00Z'

          exclude-any-issue-labels: 'help wanted, upstream'

          process-only: 'issues'

```



This step will lock only pull requests, and exclude those

with the `wip` label applied.



```yaml

    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.



```yaml

    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.



```yaml

    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, and have the `qa: verified` label applied.



```yaml

    steps:

      - uses: dessant/lock-threads@v5

        with:

          discussion-inactive-days: '180'

          include-any-discussion-labels: 'qa: verified'

          process-only: 'discussions'

```



### Commenting and labeling



This step will post a comment on issues and pull requests before locking them,

and apply the `outdated` label to issues.



```yaml

    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.



```yaml

    steps:

      - uses: dessant/lock-threads@v5

        with:

          add-issue-labels: 'qa: done, archived'

          remove-issue-labels: 'qa: primary, needs: user feedback'

          process-only: 'issues'

```



### Using a personal access token



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](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)

with the `repo` or `public_repo` scopes enabled, and add the token as an

[encrypted secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)

for the repository or organization, then provide the action with the secret

using the `github-token` input parameter.



```yaml

    steps:

      - uses: dessant/lock-threads@v5

        with:

          github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

```



## How are issues, pull requests and discussions determined to be inactive?



The action uses GitHub's [updated](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-when-an-issue-or-pull-request-was-created-or-last-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`.



## Why are only some issues, pull requests and discussions processed?



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.



## License



Copyright (c) 2017-2023 Armin Sebastian



This software is released under the terms of the MIT License.

See the [LICENSE](LICENSE) file for further information.