Merge pull request #5268 from IntersectMBO/nm/changelog-linting

Changelog linting

Author: neilmayhew

.git-blame-ignore-revs

@@ -3,6 +3,14 @@
 # from the repository's root to tell `git blame` to ignore
 # the commits below.
 
+# Use different bullet characters for different list levels in CHANGELOGs
+# CommitDate: Thu Sep 4 22:48:33 2025 -0600
+dd81c3f9e2acd33e58911cff1688232fd3593680
+
+# Fix formatting inconsistencies and errors in CHANGELOG files
+# CommitDate: Thu Sep 4 22:48:33 2025 -0600
+d91a32057ba6c0caa97a5282b652c36c8b6a601a
+
 # Apply `fourmolu` with `respectful: false`
 # CommitDate: Mon May 12 14:08:08 2025 -0600
 4b79a7a9fb54aabe567e2a4f83825616046f7ab3

.github/workflows/haskell.yml

@@ -645,3 +645,25 @@ jobs:
           echo 'The diff must not contain any `undefined` values'
           false
         fi
+
+  changelog-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install changelog linter
+      run: |
+        REPO=cardano-ledger-release-tool
+        RELEASE=changelogs-0.1.0.0
+        curl -sSfL "https://github.com/input-output-hk/$REPO/releases/download/$RELEASE/$REPO-Linux-x86_64.zip" -o $REPO.zip
+        BINDIR=$HOME/.local/bin
+        mkdir -p "$BINDIR"
+        unzip $REPO.zip -d "$BINDIR"
+        rm $REPO.zip
+        echo "$BINDIR" >> $GITHUB_PATH
+
+    - name: Run linter
+      run: |
+        git ls-files '*CHANGELOG.md' | xargs -r changelogs --inplace
+        git diff --exit-code

CHANGELOG.md

@@ -27,19 +27,19 @@
 ## 1.7.0.0
 
 * Add `DecCBOR` instances for:
-  * `Timelock`
-  * `AllegraTxAuxData`
-  * `AllegraTxBody`
+  - `Timelock`
+  - `AllegraTxAuxData`
+  - `AllegraTxBody`
 * Converted `CertState` to a type family
 * Made the fields of predicate failures and environments lazy
 * Add `Era era` constraint to `NoThunks` instance for `TimeLock`
 * Remove `Era era` constraint from:
-  * `getRequireSignatureTimelock`
-  * `getRequireAllOfTimelock`
-  * `getRequireAnyOfTimelock`
-  * `getRequireMOfTimelock`
-  * `getTimeStartTimelock`
-  * `getTimeExpireTimelock`
+  - `getRequireSignatureTimelock`
+  - `getRequireAllOfTimelock`
+  - `getRequireAnyOfTimelock`
+  - `getRequireMOfTimelock`
+  - `getTimeStartTimelock`
+  - `getTimeExpireTimelock`
 * Add `MemPack` instance for `Timelock`
 * Remove deprecated `AuxiliaryData` type synonym
 * Deprecate `Allegra` type synonym
@@ -64,24 +64,24 @@
 ## 1.5.0.0
 
 * Replace patterns within `Timelock` with `AllegraEraScript`- constrained ones:
-  * `RequireTimeExpire`
-  * `RequireTimeStart`
+  - `RequireTimeExpire`
+  - `RequireTimeStart`
 * Remove `Timelock` patterns:
-  * `RequireSignature`
-  * `RequireAllOf`
-  * `RequireAnyOf`
-  * `RequireMOf`
+  - `RequireSignature`
+  - `RequireAllOf`
+  - `RequireAnyOf`
+  - `RequireMOf`
 * Introduce `AllegraEraScript` class
 * Add `AllegraEraScript` and `ShelleyEraScript` instances for `AllegraEra`
 * Change signatures of `evalTimelock` and `validateTimelock`:
-  * replace `Era` constraint with `AllegraEraScript`
-  * replace `Timelock` with `NativeScript`
+  - replace `Era` constraint with `AllegraEraScript`
+  - replace `Timelock` with `NativeScript`
 
 ### testlib
 
 * Change signatures of `Arbitrary` instances for `Timelock` and `AllegraTxAuxData era`:
-  * replace `Era` constraint with `AllegraEraScript`
-  * add `NativeScript era ~ Timelock era` constraint
+  - replace `Era` constraint with `AllegraEraScript`
+  - add `NativeScript era ~ Timelock era` constraint
 
 ## 1.4.1.0
 
@@ -179,9 +179,9 @@
 ## 1.1.1.0
 
 * Add `TranslateEra` instances for:
-  * `DState`
-  * `PState`
-  * `VState`
+  - `DState`
+  - `PState`
+  - `VState`
 
 ## 1.1.0.0