Skip to content

Check pull request description checklist

Actions
Reads pull request body and makes sure that items are checked or struck out to make reading descriptions easier
v1.1
Latest
Star (0)

check-pull-request-description-checklist

Reads pull request body and makes sure that items are checked or struck out to make reading descriptions easier for maintainers and contributors.

inputs:
  checklist-items:
    description: List of newline separated check list items that should be checked our struck out, e.g. `DCO added to all commits`
    required: true

Usage

name: "PR description check"
on:
  pull_request:
    types:
      - opened
      - edited
      - reopened

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: peternied/[email protected]
        with:
          checklist-items: |
            Added unit test(s)

Changelog

v1.1

  • Ignore items where the checkbox is part of the strike-through by @msfroh

v1

  • Initial Release

Check pull request description checklist is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Reads pull request body and makes sure that items are checked or struck out to make reading descriptions easier
v1.1
Latest

Check pull request description checklist is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.