Git Product home page Git Product logo

github-pr-tasklist-checker's Introduction

GitHub PR Tasklist Checker

An Action to check if the PR task list is complete.

Features

This Action gives you more control over your pull request task list.
Also, when a check is missing, this not only causes the Action to fail, but also points it out in the comments.

Screenshots

How to use

I recommend creating a Pull Request template.
In it, write the tasks you want contributors to check.

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 title
- [ ] <!-- (Options) --> Task title
Options
  • Optional Make it an optional task
- [ ] <!-- Optional --> Task title
  • Choice Create choices.
- [ ] <!-- Choice --> Task title
- [ ] <!-- Choice --> Task title

When asking several questions, you must specify an ID.

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

- [ ] <!-- Choice#2 --> Task title
- [ ] <!-- Choice#2 --> Task title
  • multiple Allow to choose more than one.
- [ ] <!-- Choice,multiple --> Task title
- [ ] <!-- Choice,multiple --> Task title

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.

github-pr-tasklist-checker's People

Contributors

awayume avatar actions-user avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.