Skip to content

Make sure all pull requests includes an updated changelog

License

Notifications You must be signed in to change notification settings

Brane-Hubsch/pr-changelog-check

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

Pull Request Changelog Checking | Github Action

Running this action will check and make sure that a specified changelog file was edited for any created pull request into given branch. In the example below, the development branch.

Usage

name: Check Changelog

on:
  pull_request:
    # Change this to your branch that you want to watch
    branches: [development]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 1

      - uses: Brane-Hubsch/pr-changelog-check@v2
        with:
          # Change this to your changelog path, defaults to docs/changelog.md
          changelog-path: "docs/changelog.md"

Created by B&H

About

Make sure all pull requests includes an updated changelog

Resources

License

Stars

Watchers

Forks

Packages

No packages published