Skip to content

A Github Action which checks if a PR template has been filled out

License

Notifications You must be signed in to change notification settings

foursquare/pr-template-fillout-verifier

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

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

PR Template Fillout Verifier

A simple Github action which allows several different actions be taken when a PR body is determined to be identical to the PR template.

Permissions

contents: read is required to read the PR template

contents: write is required for converting a PR to a Draft

pull-requests: write is required to comment on the PR

Parameters

See https://github.com/foursquare/pr-template-fillout-verifier/blob/main/action.yaml#L3.

Example Usage

name: Check that PR was filled out

on:
  pull_request_target:
    types: [ opened, reopened, ready_for_review, edited ]

jobs:
  check_pr_description:
    runs-on: ubuntu-20.04
    permissions:
      contents: write
      pull-requests: write
    steps:
      - id: check-pr
        uses: foursquare/[email protected]
        if: github.event.pull_request.draft == false
        with:
          comment: 'Please fill out the PR template'
          fail: "true"
          convert-to-draft: "true"
          template-path: ".github/pull_request_template.md"

About

A Github Action which checks if a PR template has been filled out

Resources

License

Stars

Watchers

Forks

Packages

No packages published