Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klaasnicolaas/action-inactivity-lock
🔒 GitHub Action to lock inactive issues or pull requests
https://github.com/klaasnicolaas/action-inactivity-lock
babel github-actions husky jest lock nodejs typescript
Last synced: 26 days ago
JSON representation
🔒 GitHub Action to lock inactive issues or pull requests
- Host: GitHub
- URL: https://github.com/klaasnicolaas/action-inactivity-lock
- Owner: klaasnicolaas
- License: apache-2.0
- Created: 2024-06-26T13:57:31.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-27T01:30:29.000Z (about 1 month ago)
- Last Synced: 2024-09-29T02:23:29.778Z (about 1 month ago)
- Topics: babel, github-actions, husky, jest, lock, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 735 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## 🔒 Inactivity Lock
[![GitHub Release][releases-shield]][releases]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE)
[![Test Status][test-shield]][test-url]
[![Code Coverage][codecov-shield]][codecov-url]
This GitHub action is useful for repositories that want to lock issues and pull requests after a certain period of inactivity, to keep the repository clean and organized.
For fetching the issues and pull requests, the action uses the [GraphQL API](https://docs.github.com/en/graphql/overview). Instead of a REST API search call, which is very limited in the number of API calls, with the result that you can quickly encounter a [secondary ratelimit](https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#rate-limit) error.
### Features
- **Lock Issues & Pull Requests**: Locks issues and pull requests after a certain period of inactivity.
- **Custom Lock Reasons**: Set custom lock reasons for issues and pull requests.
- **Rate Limit Buffer**: Set a rate limit buffer to prevent rate limit issues.
- **Detailed Error Messages**: Provides clear error messages when something goes wrong.
## Example workflow
```yaml
name: Lock
on:
schedule:
- cron: "0 3 * * *"
workflow_dispatch:
jobs:
inactivity-lock:
name: Lock issues and PRs
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: 🔒 Lock closed issues and PRs
uses: klaasnicolaas/action-inactivity-lock@v1
with:
days-inactive-issues: 30
days-inactive-prs: 30
lock-reason-issues: ""
lock-reason-prs: ""
```
## Inputs
The following input parameters can be used to configure the action.
_If no input parameters are provided, the action will use the default values._
### `repo-token`
The GitHub token used to interact with the GitHub API.
- Default: `${{ github.token }}`
- Usage: **Optional**
### `rate-limit-buffer`
The rate limit buffer is to prevent rate limit issues with the GitHub API. GitHub has a rate limit of 5000 requests per hour. The action will stop if the rate limit buffer is reached. for example, if the rate limit buffer is set to `200`, the action will stop when the remaining request reached `200`.
- default: `100`
- Usage: **Optional**
### `days-inactive-issues`
The number of days an issue should be inactive before it gets locked.
- default: `90`
- Usage: **Optional**
### `days-inactive-prs`
The number of days a pull request should be inactive before it gets locked.
- default: `90`
- Usage: **Optional**
### `lock-reason-issues`
The reason that will be used to lock the issues. Valid reasons are: `off-topic`, `too heated`, `resolved`, `spam`, `""`.
- default: `resolved`
- Usage: **Optional**
### `lock-reason-prs`
The reason that will be used to lock the pull requests. Valid reasons are: `off-topic`, `too heated`, `resolved`, `spam`, `""`.
- default: `resolved`
- Usage: **Optional**
## Outputs
The following output can be used to display the locked issues and pull requests.
Both outputs are a list of objects with the following structure:
```javascript
[
{ number: 1, title: "Title" },
{ number: 2, title: "Title" }
]
```
### `locked-issues`
A list of issues that have been locked.
### `locked-prs`
A list of pull requests that have been locked.
## Full example workflow
```yaml
name: Lock
on:
schedule:
- cron: "0 3 * * *"
workflow_dispatch:
jobs:
inactivity-lock:
name: Lock issues and PRs
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: 🔒 Lock closed issues and PRs
uses: klaasnicolaas/action-inactivity-lock@v1
id: lock
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
rate-limit-buffer: 200
days-inactive-issues: 30
days-inactive-prs: 30
lock-reason-issues: "resolved"
lock-reason-prs: "resolved"
- name: 🔍 Display locked issues and PRs
run: |
echo "Locked issues: $(echo '${{ steps.lock.outputs.locked-issues }}' | jq)"
echo "Locked PRs: $(echo '${{ steps.lock.outputs.locked-prs }}' | jq)"
```
## Contributing
This is an active open-source project. We are always open to people who want to
use the code or contribute to it.
We've set up a separate document for our
[contribution guidelines](CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## License
Distributed under the **Apache License 2.0** license. See [`LICENSE`](LICENSE) for more information.
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/action-inactivity-lock/branch/main/graph/badge.svg?token=FJXBX4ZTI1
[codecov-url]: https://codecov.io/gh/klaasnicolaas/action-inactivity-lock
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/action-inactivity-lock.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/action-inactivity-lock.svg
[releases]: https://github.com/klaasnicolaas/action-inactivity-lock/releases
[test-shield]: https://github.com/klaasnicolaas/action-inactivity-lock/actions/workflows/tests.yaml/badge.svg
[test-url]: https://github.com/klaasnicolaas/action-inactivity-lock/actions/workflows/tests.yaml