https://github.com/trixi-framework/add-pr-review-checklist
GitHub Action for adding a review checklist to newly created pull requests
https://github.com/trixi-framework/add-pr-review-checklist
Last synced: 4 months ago
JSON representation
GitHub Action for adding a review checklist to newly created pull requests
- Host: GitHub
- URL: https://github.com/trixi-framework/add-pr-review-checklist
- Owner: trixi-framework
- License: mit
- Created: 2023-08-17T06:08:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T19:08:27.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T17:28:22.612Z (6 months ago)
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Add PR review checklist
GitHub Action for adding a review checklist to newly created pull requests.
## Usage
Add your Markdown-formatted review checklist to your repository, e.g., as
`.github/review-checklist.md`. An example checklist can be found
[here](example-review-checklist.md).
Then, create a file `.github/workflows/ReviewChecklist.yml` with the following content:
```yml
name: Add review checklist
on:
pull_request_target:
types: [opened]
permissions:
pull-requests: write
jobs:
add-review-checklist:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Add review checklist
uses: trixi-framework/add-pr-review-checklist@v1
with:
file: '.github/review-checklist.md'
no-checklist-keyword: '[no checklist]'
```
Modify the `file` input parameter to contain the path to your checklist file. If the string
specified by the `no-checklist-keyword` parameter is found in the pull request description,
no checklist is created. This can be useful for, e.g., trivial PRs that does not
require a full review.
## Author
This repository was initiated by [Michael Schlottke-Lakemper](https://lakemper.eu).
## License
This repository is licensed under the MIT license (see [LICENSE.md](LICENSE.md)).