Merge pull request #5335 from IntersectMBO/nm/changelog-linting-exit-status

Improve error checking in CI changelog linting

Author: neilmayhew

.github/workflows/haskell.yml

@@ -655,16 +655,16 @@ jobs:
     - name: Install changelog linter
       run: |
         REPO=cardano-ledger-release-tool
-        RELEASE=cardano-ledger-release-tool-0.1.0.0
-        curl -sSfL "https://github.com/input-output-hk/$REPO/releases/download/$RELEASE/$REPO-Linux-x86_64.zip" -o $REPO.zip
+        RELEASE=0.1.1.0 # Should match nix/pkgs/cardano-ledger-release-tool.nix
+        curl -sSfL "https://github.com/input-output-hk/$REPO/releases/download/$RELEASE/$REPO-Linux-x86_64-$RELEASE.tgz" -o $REPO.tgz
         BINDIR=$HOME/.local/bin
         mkdir -p "$BINDIR"
-        unzip -qo $REPO.zip -d "$BINDIR"
-        rm $REPO.zip
+        tar -xvf $REPO.tgz --strip-components=1 -C "$BINDIR"
+        rm $REPO.tgz
         echo "$BINDIR" >> ${GITHUB_PATH-/dev/null}
 
     - name: Run linter
-      run: scripts/format-changelogs.sh || git diff --exit-code
+      run: scripts/format-changelogs.sh || (git diff; false)
 
     - name: Check if changelogs need a bump
       run: scripts/bump-changelogs.sh || (git diff; false)

nix/pkgs/cardano-ledger-release-tool.nix

@@ -3,6 +3,6 @@ let
   type = "github";
   owner = "input-output-hk";
   repo = "cardano-ledger-release-tool";
-  rev = "f52262644af02e6eae54cf5d6021ecebf7f5c1d1";
+  rev = "98b7da19a6e385c62292125a5cede79f444dd9b9"; # git rev-parse 0.1.1.0
 in
 (builtins.getFlake "${type}:${owner}/${repo}/${rev}").packages.${system}.default

scripts/format-changelogs.sh

@@ -9,6 +9,14 @@ then
   mapfile -t FILES < <(git ls-files '*CHANGELOG.md')
 fi
 
-cardano-ledger-release-tool changelogs -i "${FILES[@]}"
+clrt changelogs -i "${FILES[@]}"
 
-git diff -s --exit-code "${FILES[@]}"
+if ! git diff -s --exit-code "${FILES[@]}"
+then
+  if [ -t 2 ]
+  then
+    # shellcheck disable=SC2016
+    echo 'Some changelogs were modified - use `git diff` to see the changes' >&2
+  fi
+  false
+fi