Skip to content

peternied/check-pull-request-description-checklist

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

GitHub action ensuring that pull requests have a description

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%