From 36a03202c68938c87b633427d6206dd8fddf2674 Mon Sep 17 00:00:00 2001 From: rootiest Date: Sat, 25 Jul 2026 22:12:48 -0400 Subject: [PATCH] fix(ci): regenerate docs before verifying manual integrity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit build-docs.yml ran verify-manual.py before regenerating docs/fish-config.md, so test_concat_roundtrips_original compared a fresh concat of docs/manual/** against the stale, pre-push copy on disk. Any ordinary edit under docs/manual/** — the exact trigger for this workflow's paths filter — failed the job before it ever regenerated anything. Swap the "Generate concatenated markdown" and "Verify manual integrity" steps so regeneration runs first. Verification still gates pandoc and the auto-commit step. Also add docs/verify-manual.py to the paths filter so edits to the integrity checker itself retrigger the job. --- .gitea/workflows/build-docs.yml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/.gitea/workflows/build-docs.yml b/.gitea/workflows/build-docs.yml index 326f126..177025f 100644 --- a/.gitea/workflows/build-docs.yml +++ b/.gitea/workflows/build-docs.yml @@ -8,6 +8,7 @@ on: - "docs/manual/**" - "docs/build-manual.py" - "docs/manualtools.py" + - "docs/verify-manual.py" jobs: build-docs: @@ -23,12 +24,20 @@ jobs: sudo apt-get update -qq sudo apt-get install -y pandoc python3-yaml - - name: Verify manual integrity - run: python3 docs/verify-manual.py - - name: Generate concatenated markdown run: python3 docs/build-manual.py --concat -o docs/fish-config.md + # Regeneration MUST run before verification: verify-manual.py's + # test_concat_roundtrips_original compares a freshly-built concat + # against docs/fish-config.md on disk. Before this step ran, that + # file was still the stale pre-push copy, so any ordinary edit under + # docs/manual/** failed the round-trip check before anything was + # regenerated. Do not reorder this back — verification still gates + # pandoc and the auto-commit below, it just no longer requires a + # contributor to hand-sync the generated file before pushing. + - name: Verify manual integrity + run: python3 docs/verify-manual.py + - name: Compile man page run: | pandoc --standalone \