Skip to content

openmodelingfoundation/pr-description-enforcer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

414b6ff · Oct 12, 2020

History

53 Commits
Oct 10, 2020
Oct 12, 2020
Oct 10, 2020
Oct 10, 2020
Oct 10, 2020
Oct 10, 2020
Oct 10, 2020
Oct 10, 2020
Oct 10, 2020
Oct 12, 2020
Oct 10, 2020
Oct 12, 2020
Oct 10, 2020
Oct 12, 2020

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: derkinderfietsen/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

github action for enforcing description on PR

Resources

Stars

Watchers

Forks

Packages

No packages published