Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awayume/github-pr-tasklist-checker
An Action to check if the PR task list is complete
https://github.com/awayume/github-pr-tasklist-checker
cjs github github-actions javascript js node nodejs project-management pull-requests task task-manager
Last synced: 5 days ago
JSON representation
An Action to check if the PR task list is complete
- Host: GitHub
- URL: https://github.com/awayume/github-pr-tasklist-checker
- Owner: Awayume
- License: mit
- Created: 2023-08-19T08:48:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-12T09:23:45.000Z (6 months ago)
- Last Synced: 2024-10-14T09:43:38.790Z (about 1 month ago)
- Topics: cjs, github, github-actions, javascript, js, node, nodejs, project-management, pull-requests, task, task-manager
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/github-pr-tasklist-checker
- Size: 48.8 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GitHub PR Tasklist Checker
An Action to check if the Pull Request task list is complete.
このドキュメントの日本語版は[こちら](/docs/README_ja.md)
## Features
This Action gives you more control over the tasks in the Pull Requests.
If there are unchecked tasks, the action will fail and the missing checks will be noted in the comments.
Screenshots
[](#)
[](#)
[](#)
[](#)
[](#)
[](#)
## How to use
Create a Pull Request template and write the tasks you want contributors to check off in it.
### About permission
This Action requires write permission to Pull Requests.
Details on [GitHub Docs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)
### Workflow template
```yaml
name: PR Moderation
on:
pull_request:
types:
- opened
- edited
- reopened
jobs:
verify:
name: Verify
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Check tasklist
uses: Awayume/github-pr-tasklist-checker@v1
```
### Syntax
##### Basic syntax
This is the basic syntax. It follows the basics of a regular markdown checklist.
It doesn't matter if there are no options.
When specifying multiple options, separate them with commas.
```markdown
- [ ] Task content
- [ ] Task content
```
##### Options
- Optional
Marks it an optional task
```markdown
- [ ] Task content
```
- Choice
Creates choices.
```markdown
- [ ] Task content
- [ ] Task content
```
When asking several questions, you must specify an ID.
```markdown
- [ ] Task content
- [ ] Task content
- [ ] Task content
- [ ] Task content
```
- multiple
Allows to choose more than one.
```markdown
- [ ] Task content
- [ ] Task content
```
##### Child Tasks
For each task, child tasks can be defined.
A child task is validated only if it is checked if the parent task is optional or optional.
```markdown
- [ ] Parent Task 1
- [ ] Child task 1
- [ ] Child task 2
- [ ] Subtasks.
- [ ] Parent Task 2
- [ ] Validated only when "Parent Task 2" is checked.
```
Child tasks can be defined by creating indents. The depth of indentation must be the same.
```markdown
- [ ] Parent task
- [ ] Child tasks
- [ ] Syntax error occurred.
```
#### Tag Policy
Tags always start with 'v' and refer to the version. Those tags are always immutable.
There are also tags for major version and minor version (v1.0, v2.0, etc.),
tags for major versions only (v1, v2, etc.), and "latest" tags.
The first two types of tags refer to the latest version starting with their name, the last type of tag refers to the latest version in the repository.