GitHub PR Tasklist Checker

An Action to check if the Pull Request task list is complete.

このドキュメントの日本語版はこちら

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

Workflow template

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.

- [ ] Task content
- [ ] <!-- (Options) --> Task content

Options

• Optional Marks it an optional task

- [ ] <!-- Optional --> Task content

• Choice Creates choices.

- [ ] <!-- Choice --> Task content
- [ ] <!-- Choice --> Task content

When asking several questions, you must specify an ID.

- [ ] <!-- Choice#1 --> Task content
- [ ] <!-- Choice#1 --> Task content

- [ ] <!-- Choice#2 --> Task content
- [ ] <!-- Choice#2 --> Task content

• multiple Allows to choose more than one.

- [ ] <!-- Choice,multiple --> Task content
- [ ] <!-- Choice,multiple --> 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.

- [ ] Parent Task 1
 - [ ] Child task 1
 - [ ] Child task 2
 - [ ] Subtasks.

- [ ] <! -- Optional --> 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.

- [ ] 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.