Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

Enforce Pull Request Description Length

v1

Enforce Pull Request Description Length

play

Enforce Pull Request Description Length

Check that a PR description is filled out

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Enforce Pull Request Description Length

              
  uses: ryanvade/enforce-pr-description-length-action@v1
Learn more about this action in ryanvade/enforce-pr-description-length-action

Choose a version

Enforce Pull Request Description Length Action

This action checks that a Pull Request Description is at a minimum length. By default the minimum length is one. If a different minimum length is needed it can be passed in using an Action Input.

Inputs

minLength

A specific minimum length the description must be.

Example Usage

- name: Enforce Jira Issue Key in Pull Request Title
  uses: ryanvade/enforce-pr-description-length-action@v1

Example Usage with a specific min length

- name: Enforce Jira Issue Key in Pull Request Title
  uses: ryanvade/enforce-pr-description-length-action@v1
  with:
    minLength: 5