Skip to content

MalteHerrmann/changelog-lint-action

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

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 }}