Skip to content
play

GitHub Action

Changelog Linter

v0.2.1 Latest version

Changelog Linter

play

Changelog Linter

A linter for your changelog. Based on https://github.com/MalteHerrmann/changelog-utils

Installation

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

              

- name: Changelog Linter

uses: MalteHerrmann/changelog-lint-action@v0.2.1

Learn more about this action in MalteHerrmann/changelog-lint-action

Choose a version

Changelog Lint Action

This GitHub action brings the linter from the changelog-utils to your CI workflows.

It's using reviewdog to post comments on PR reviews that show any potential problems with your changelogs.

Example Workflow

name: Changelog Linter

on:
  pull_request:

permissions:
  pull-requests: write
  contents: read

jobs:
  lint-changelog:
    runs-on: ubuntu-latest

    steps:
    - name: Check out the repository
      uses: actions/checkout@v4

    - name: Run changelog linter
      uses: MalteHerrmann/changelog-lint-action@v0.2.1
      with:
          github_token: ${{ secrets.GITHUB_TOKEN }}