feat(ci): Add reviewdog implementation (#4)

* commit wip adding reviewdog implementation

* bump version in used ci action

* add GH token to use with linter

* make entrypoint executable

* remove filter from reviewdog (not functioning correctly somehow..)

* write permissions for action

* perms 2

* fail on error

* add readme

* adjust name

* update changelog

.github/workflows/lint-changelog.yaml

@@ -3,6 +3,10 @@ name: Changelog Linter
 on:
   pull_request:
 
+permissions:
+  pull-requests: write
+  contents: read
+
 jobs:
   lint-changelog:
     runs-on: ubuntu-latest
@@ -12,5 +16,8 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Run changelog linter
-      uses: MalteHerrmann/changelog-lint-action@0918ef12e6dc06adce0743e1c6c13707a7c20323
+      uses: ./
+      with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
 

CHANGELOG.md

@@ -8,4 +8,5 @@ This changelog was created using the `clu` binary
 
 ### Features
 
+- (ci) [#2](https://github.com/MalteHerrmann/changelog-lint-action/pull/2) Add reviewdog to post PR review comments.
 - (ci) [#1](https://github.com/MalteHerrmann/changelog-lint-action/pull/1) Add action implementation.

Dockerfile

@@ -2,4 +2,6 @@ FROM ghcr.io/malteherrmann/changelog-utils:latest
 
 WORKDIR /github/workspace
 
-CMD ["lint"]
+COPY entrypoint.sh .
+
+ENTRYPOINT ["./entrypoint.sh"]

README.md

@@ -0,0 +1,7 @@
+# Changelog Lint Action
+
+This GitHub action brings the linter from the [changelog-utils](https://github.com/MalteHerrmann/changelog-utils)
+to your CI workflows.
+
+It's using [reviewdog](https://github.com/reviewdog/reviewdog) to post comments on PR reviews that show any potential
+problems with your changelogs.

action.yml

@@ -1,6 +1,10 @@
 name: 'Changelog Linter'
 description: 'A linter for your changelog. Based on https://github.com/MalteHerrmann/changelog-utils'
 author: 'Malte Herrmann'
+inputs:
+  github_token:
+    description: 'GITHUB_TOKEN'
+    default: '${{ github.token }}'
 outputs:
   linter-results:
     description: 'Changelog linter output'

entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+set -ex
+
+export REVIEWDOG_GITHUB_API_TOKEN="${INPUT_GITHUB_TOKEN}"
+
+clu lint | reviewdog -efm="%f:%l: %m" \
+      -name="clu" \
+      -reporter="github-pr-review" \
+      -filter-mode="nofilter" \
+      -fail-on-error="true"