Files
HellionChat/scripts/verify-changelog-sync.sh
T
JonKazama-Hellion 5f7bfb5890
Security / scan (push) Successful in 23s
Build / Build (Release) (push) Successful in 31s
fix(preflight): avoid jq SIGPIPE race in verify-changelog-sync
The Block C check used `jq -r '.[0].Changelog' | grep -qE ...` to spot
the **vX.Y.Z** marker. With `set -o pipefail`, grep -q closing stdin on
the first match makes jq trip SIGPIPE on the rest of the multi-KB
Changelog string, which the script then surfaces as a false-positive
"Changelog missing **vX.Y.Z** subblock" failure. Interactive shells
sometimes raced through fast enough to hide the issue, but the pre-push
runner hit it reliably (saw it on the v1.4.10 release-cut push attempt).

Switched the pipe to a process substitution so jq writes into a FIFO
and SIGPIPE never enters the picture. Both directions of the marker
check now stay deterministic.
2026-05-16 14:08:19 +02:00

51 lines
2.5 KiB
Bash
Executable File

#!/usr/bin/env bash
# verify-changelog-sync.sh — Block C.
# Strips .0 suffix from repo.json AssemblyVersion to derive the 3-digit tag/version.
# yaml.changelog is a single multi-line block with **vX.Y.Z** subblocks.
set -euo pipefail
ROOT="$(cd "$(dirname "$0")/.." && pwd)"
YAML="$ROOT/HellionChat/HellionChat.yaml"
REPO_JSON="$ROOT/repo.json"
FORGE_DIR="$ROOT/.github/forge-posts"
fail() { echo "verify-changelog-sync: FAIL — $1" >&2; exit 1; }
ok() { echo "verify-changelog-sync: OK — $1"; }
VER="$(jq -r '.[0].AssemblyVersion' "$REPO_JSON" | sed -E 's/\.0$//')"
TAG="v$VER"
grep -qE "^[[:space:]]*\*\*v${VER}[^0-9]" "$YAML" \
|| fail "$YAML changelog missing **v${VER}** subblock. Fix: add the v${VER} block at the top of the changelog field."
# Process substitution instead of `jq | grep -q` — grep -q closes stdin on the
# first match, jq keeps writing the multi-KB Changelog string and trips SIGPIPE,
# which `set -o pipefail` then turns into a false-positive FAIL. Manifested as a
# `jq: writing output failed: Broken pipe` line plus a misleading "Changelog
# missing **vX.Y.Z** subblock" message during pre-push runs.
grep -qE "^[[:space:]]*\*\*v${VER}[^0-9]" <(jq -r '.[0].Changelog' "$REPO_JSON") \
|| fail "$REPO_JSON Changelog missing **v${VER}** subblock. Fix: copy the yaml changelog over."
FORGE_FILE="$FORGE_DIR/${TAG}.md"
[ -f "$FORGE_FILE" ] || fail "$FORGE_FILE missing. Fix: create from previous tag's file as template."
SUBTITLE="$(awk '/^---$/{f=!f; next} f && /^subtitle:/' "$FORGE_FILE" | sed -E 's/^subtitle:[[:space:]]*//' | tr -d '\"')"
[ -n "$SUBTITLE" ] || fail "$FORGE_FILE frontmatter missing 'subtitle'."
[ "${#SUBTITLE}" -le 60 ] || fail "$FORGE_FILE subtitle is ${#SUBTITLE} chars (max 60)."
NATUR="$(awk '/^---$/{f=!f; next} f && /^versionsnatur:/' "$FORGE_FILE" | sed -E 's/^versionsnatur:[[:space:]]*//' | tr -d '\"')"
[ -n "$NATUR" ] || fail "$FORGE_FILE frontmatter missing 'versionsnatur'."
[ "${#NATUR}" -le 40 ] || fail "$FORGE_FILE versionsnatur is ${#NATUR} chars (max 40)."
BODY="$(awk '/^---$/{f++; next} f==2' "$FORGE_FILE")"
TITLE_LEN=$((${#VER} + 16 + ${#SUBTITLE}))
FOOTER_LEN=80
TOTAL=$((TITLE_LEN + ${#BODY} + FOOTER_LEN))
[ "$TOTAL" -le 5500 ] || fail "Forge embed total ~${TOTAL} chars > 5500 cap."
YAML_VERSIONS="$(grep -cE '^[[:space:]]*\*\*v[0-9]+\.[0-9]+\.[0-9]+' "$YAML" || true)"
[ "$YAML_VERSIONS" -le 4 ] || fail "$YAML changelog has $YAML_VERSIONS version subblocks (max 4). Fix: move oldest to docs/CHANGELOG.md."
ok "yaml/repo.json/forge-post in sync for $TAG, embed-total ~${TOTAL}/5500, $YAML_VERSIONS/4 subblocks"