Add changelog test in CI (#7)

Author: ia0

.github/workflows/cli.yml

@@ -33,6 +33,9 @@ jobs:
           rustup component add clippy rustfmt
       - name: Checkout repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          # This is needed to test that CHANGELOG.md is up-to-date.
+          fetch-depth: 0
       # TODO(https://github.com/actions/cache/issues/1539): Just use actions/cache instead of the
       # work-around. The only relevant steps in-between are the cargo install commands.
       # BEGIN work-around

cli/CHANGELOG.md

@@ -15,3 +15,5 @@
 ## 0.0.0
 
 No content.
+
+<!-- Increment to skip CHANGELOG.md test: 0 -->

cli/ci.sh

@@ -16,12 +16,14 @@
 set -e
 . ./color.sh
 
-info "Checking CHANGELOG.md version"
+info "Checking if CHANGELOG.md is up-to-date"
 x="$(sed -n '3s/^## //p' CHANGELOG.md)"
 y="$(sed -n '3s/^version = "\(.*\)"/\1/p' Cargo.toml)"
 [ -n "$x" ] || error "Missing version in CHANGELOG.md"
 [ -n "$y" ] || error "Missing version in Cargo.toml"
-[ "$x" = "$y" ] || error "Version mismatch between Cargo.toml and CHANGELOG.md"
+[ "$x" = "$y" ] || error "CHANGELOG.md version differs from Cargo.toml"
+ref=$(git log -n1 --pretty=format:%H origin/main.. -- CHANGELOG.md)
+git diff --quiet ${ref:-origin/main} -- Cargo.* src || error "CHANGELOG.md is not up-to-date"
 
 info "Running unit tests"
 ./test.sh

cli/release.sh

@@ -25,6 +25,9 @@ info "Removing all -git suffixes"
 sed -i 's/-git//' Cargo.* CHANGELOG.md
 VERSION="${VERSION%-git}"
 
+info "Reset CHANGELOG.md counter"
+sed -i 's/\(^<!-- .* test\): [0-9]* -->$/\1: 0 -->/' CHANGELOG.md
+
 info "Updating README.md"
 sed -i 's#\(releases/tag/cli/v\).*$#\1'"$VERSION"'#' README.md