grafana/changelog-checker

GitHub Action checking that CHANGELOG.md has been updated

Why

This action will check that the changelog file has been updated in the PR. It will add a check on the PR which can be required for blocking the merge.

The changelog file name can be customized with fileName parameter.

The check can be disabled for a PR with a label. This label can be customized with the noChangelogLabel parameter.

The checkNotification allows switching between Simple and Detailed checks. The simple check is based on the default check of the action. The detailed check will create a second check with a more precise message, but it required write access so it does not work with forks.

Detailed check fallback to simple for forks.

Usage:

name: MyLittleWorkflow
on:
  pull_request:
    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
    branches:
      - main
      - develop
jobs:
  build:
    name: Check Actions
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Changelog check
        uses: Zomzog/changelog-checker@v1.2.0
        with:
          fileName: myChangelog.adoc # default `CHANGELOG.adoc`
          noChangelogLabel: my custom label # default `no changelog`
          checkNotification: Simple # default `Detailed`
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Develop

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run pack

Run the tests ✔️

$ npm test

Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run

$ npm run pack
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Your action is now published! 🚀