chore: update docs

This commit is contained in:
dessant
2025-12-12 17:24:43 +02:00
parent 6548363a2d
commit e15e78d779
2 changed files with 15 additions and 15 deletions

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2017-2023 Armin Sebastian
Copyright (c) 2017-2025 Armin Sebastian
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -22,7 +22,7 @@ directory, use one of the [example workflows](#examples) to get started.
### Inputs
<!-- prettier-ignore -->
The action can be configured using [input parameters](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith).
The action can be configured using [input parameters](https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepswith).
- **`github-token`**
- GitHub access token, value must be `${{ github.token }}` or an encrypted
@@ -253,7 +253,7 @@ jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
```
Edit the workflow after the initial backlog of issues, pull requests
@@ -293,7 +293,7 @@ jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
github-token: ${{ github.token }}
issue-inactive-days: '365'
@@ -349,7 +349,7 @@ or those with the `help wanted` or `upstream` labels applied.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
exclude-issue-created-before: '2018-01-01T00:00:00Z'
exclude-any-issue-labels: 'help wanted, upstream'
@@ -362,7 +362,7 @@ with the `wip` label applied.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
exclude-any-pr-labels: 'wip'
process-only: 'prs'
@@ -374,7 +374,7 @@ or those created in 2018 and 2019.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
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'
@@ -388,7 +388,7 @@ labels applied.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
include-any-issue-labels: 'incomplete, invalid'
include-all-pr-labels: 'qa: done, published'
@@ -401,7 +401,7 @@ in the past 180 days, and have the `qa: verified` label applied.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
discussion-inactive-days: '180'
include-any-discussion-labels: 'qa: verified'
@@ -416,7 +416,7 @@ and apply the `outdated` label to issues.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
add-issue-labels: 'outdated'
issue-comment: >
@@ -437,7 +437,7 @@ before locking issues.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
add-issue-labels: 'qa: done, archived'
remove-issue-labels: 'qa: primary, needs: user feedback'
@@ -451,15 +451,15 @@ 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)
with the `repo` or `public_repo` scopes enabled, and add the token as a
[secret](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository)
for the repository or organization, then provide the action with the secret
using the `github-token` input parameter.
<!-- prettier-ignore -->
```yaml
steps:
- uses: dessant/lock-threads@v5
- uses: dessant/lock-threads@v6
with:
github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
```
@@ -485,7 +485,7 @@ it will take a few hours or days to process them all.
## License
Copyright (c) 2017-2023 Armin Sebastian
Copyright (c) 2017-2025 Armin Sebastian
This software is released under the terms of the MIT License.
See the [LICENSE](LICENSE) file for further information.