Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashfurrow/task-list-checker
https://github.com/ashfurrow/task-list-checker
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ashfurrow/task-list-checker
- Owner: ashfurrow
- License: mit
- Created: 2021-06-18T12:26:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-29T19:40:48.000Z (over 3 years ago)
- Last Synced: 2024-10-14T18:45:17.586Z (2 months ago)
- Language: JavaScript
- Size: 859 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# task-list-checker
This is a GitHub Action to look for incomplete [task list](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-issues/about-task-lists) items in pull requests.
## Usage
### Setup
Add this to your GitHub project by creating `.github/workflows/task-list-checker.yml` with the following contents:
```yml
name: GitHub Task List Checker
on:
pull_request:
types: [opened, edited]
jobs:
task-list-checker:
runs-on: ubuntu-latest
steps:
- name: Check for incomplete task list items
uses: Shopify/task-list-checker@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### In a pull request
When a PR is first opened, and any time the description is edited (including automatic edits triggered by clicking on a checkbox), `task-list-checker` will count the checked and unchecked checkboxes in the description. If any tasks are unchecked, it will set the PR's status to `pending`, blocking merge.
Checkboxes in comments are ignored, since scattering tasks throughout the PR makes it harder for authors/reviewers to locate the remaining tasks. If a task is related to a specific file or comment, add the checkbox to the PR description with a link out to the relevant location.
Any checkbox containing the text **N/A** (all caps) will be skipped; use this to tag tasks that are not relevant to the current PR. Ex:
```
- [ ] ~updated storybook~ N/A, no new components
```
Any checkbox containing the text **POST-MERGE:** (all caps) will be skipped; use this to tag tasks that will be completed after the merge. Ex:
```
- [ ] POST-MERGE: ramp the feature flag
```
### Checkbox inflation
Uninflated checkboxes in code blocks or tables are ignored. Nested checkboxes, indented checkboxes, and checkboxes in `>` blockquotes are NOT ignored.
#### Uninflated checkboxes
```
- [ ] this checkbox would be ignored since markdown doesn't inflate checkboxes in code blocks
```
| table |
| --- |
| - [ ] this checkbox would also be ignored, since markdown doesn't inflate checkboxes in tables |
#### Inflated checkboxes
- [ ] inflated checkboxes count toward the total
- [ ] even if they're nested
> - [ ] or in a block quote
## Project Status
See [PROJECT_STATUS](PROJECT_STATUS.md) for the current todo list.
## License
MIT.