Description
The finalize job in release.yml explicitly sets install-just: 'false' (line 505), but then runs docs/generate.py (line 521) which calls just --list. Without just installed, get_just_help() silently falls back to a placeholder comment, replacing ~130 lines of just recipe documentation in README.md and CONTRIBUTE.md with <!-- Run 'just --list' to see available recipes -->.
The corrupted docs are committed by commit-action, and the subsequent CI project-checks job fails because its generate-docs pre-commit hook (which has just installed) regenerates the correct content, detecting a diff.
Steps to Reproduce
- Run
just finalize-release 0.3.2 (or any version)
- The
release.yml finalize job runs setup-env with install-just: 'false'
docs/generate.py runs, just --list fails silentlyREADME.md and CONTRIBUTE.md committed with placeholder content- CI project-checks runs pre-commit,
generate-docs detects stale docs, fails
Expected Behavior
The finalize commit should contain the correct just --list output in README.md and CONTRIBUTE.md, and CI project checks should pass.
Actual Behavior
The finalize commit replaces the just recipes section with <!-- Run 'just --list' to see available recipes -->. CI project-checks fails because generate-docs pre-commit regenerates the correct content.
Environment
- Workflow:
.github/workflows/release.yml, finalize job
- Runner: ubuntu-22.04
- Affected release: 0.3.2
Possible Solution
Remove install-just: 'false' from the finalize job's setup-env step (line 505 of release.yml), allowing just to be installed (the default). The docs/generate.py script requires just to correctly generate documentation.
Additionally, consider hardening get_just_help() in docs/generate.py to fail hard (exit non-zero) rather than silently falling back, so this class of error is caught immediately instead of producing corrupted output.
Changelog Category
Fixed
Description
The
finalizejob inrelease.ymlexplicitly setsinstall-just: 'false'(line 505), but then runsdocs/generate.py(line 521) which callsjust --list. Withoutjustinstalled,get_just_help()silently falls back to a placeholder comment, replacing ~130 lines of just recipe documentation inREADME.mdandCONTRIBUTE.mdwith<!-- Run 'just --list' to see available recipes -->.The corrupted docs are committed by
commit-action, and the subsequent CI project-checks job fails because itsgenerate-docspre-commit hook (which hasjustinstalled) regenerates the correct content, detecting a diff.Steps to Reproduce
just finalize-release 0.3.2(or any version)release.ymlfinalize job runssetup-envwithinstall-just: 'false'docs/generate.pyruns,just --listfails silentlyREADME.mdandCONTRIBUTE.mdcommitted with placeholder contentgenerate-docsdetects stale docs, failsExpected Behavior
The finalize commit should contain the correct
just --listoutput inREADME.mdandCONTRIBUTE.md, and CI project checks should pass.Actual Behavior
The finalize commit replaces the just recipes section with
<!-- Run 'just --list' to see available recipes -->. CI project-checks fails becausegenerate-docspre-commit regenerates the correct content.Environment
.github/workflows/release.yml, finalize jobPossible Solution
Remove
install-just: 'false'from the finalize job'ssetup-envstep (line 505 ofrelease.yml), allowingjustto be installed (the default). Thedocs/generate.pyscript requiresjustto correctly generate documentation.Additionally, consider hardening
get_just_help()indocs/generate.pyto fail hard (exit non-zero) rather than silently falling back, so this class of error is caught immediately instead of producing corrupted output.Changelog Category
Fixed