Task Completed Checker Action
A GitHub action that checks if all tasks are completed in the pull requests.
โถ๏ธ Usage
Create a workflow
name: 'PR Tasks Completed Check'
on:
pull_request:
types: [opened, edited]
jobs:
task-check:
runs-on: ubuntu-latest
steps:
- uses: kentaro-m/[email protected]
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"Check whether tasks are completed
Add a pull request template to your repository (.github/pull_request_template.md).
For example:
## Issue Type
<!-- ignore-task-list-start -->
- [ ] Bug
- [ ] Document
- [ ] Enhancement
<!-- ignore-task-list-end -->
## Checklist
- [x] I have read the [CONTRIBUTING.md]()
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no lint errors
- [x] I have added tests that prove my fix is effective or that my feature works
- [x] New and existing unit tests pass locally with my changesCreate a pull request that contained tasks list to your repository and will be started automatically a workflow to check whether tasks are completed.
Every time edit a description of a pull request will be started automatically a new workflow to check.
You can check a list of completed tasks and uncompleted tasks at the Actions page.
Ignore checks whether tasks are completed
Please surround the task list with <!-- ignore-task-list-start --> and <!-- ignore-task-list-end --> for ignoring checks whether tasks are completed.
## Issue Type
<!-- ignore-task-list-start -->
- [ ] Bug
- [ ] Document
- [x] Enhancement
<!-- ignore-task-list-end -->
## Checklist
- [x] I have read the [CONTRIBUTING.md]()
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no lint errors
- [x] I have added tests that prove my fix is effective or that my feature works
- [x] New and existing unit tests pass locally with my changes๐ Licence
MIT