Skip to content

dekinderfiets/pr-description-enforcer

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

Repository files navigation

Pull Request Description Enforcer

github action for enforcing description on pull requests, it will reject empty descriptions or unedited pull request template descriptions.

Usage

Create Workflow

Create a workflow (eg: .github/workflows/pr-description-enforcer.yml see Creating a Workflow file) to utilize the action with content:

# This workflow will enforce description on pull requests.

name: 'PR Description Enforcer'
on:
    pull_request:
        types: [opened, edited, reopened]

jobs:
    enforce:
        runs-on: ubuntu-latest

        steps:
            - uses: dekinderfiets/pr-description-enforcer@v1
              with:
                  repo-token: '${{ secrets.GITHUB_TOKEN }}'

Note: This grants access to the GITHUB_TOKEN so the action can make calls to GitHub's rest API

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published