Repository navigation
docs(contrail-gh): record the template's reliance on sync --passport - #85
Merged
Merged
Conversation
contrail-gh's sync.yml now treats exit 3 from `sync --passport` as "log saved, page failed" and commits anyway, stopping on anything else, and both its file_pattern and publish-passport.yml expect passport.html. A change to either is now a row in the obligations table, and the Passport paragraph says how the template builds and can publish it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Rk5Jex5dGPsKhePMEJeuV
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
docs/contrail-gh.mdgains an obligations-table row forsync --passport's exit codes and Passport's default path, and its Passport paragraph now says the template builds the page withcontrail sync --passportand can opt in to publishing it withpublish-passport.yml. mdformat re-padded the whole table for the longer first column, so every row shows in the diff; only the new row's content is new.Why
Since atdr/contrail-gh#25, the template's
sync.ymltreats exit 3 as "log saved, page failed" and commits anyway, and stops before the commit on any other non-zero. Itsfile_patternandpublish-passport.yml(atdr/contrail-gh#23) both expectpassport.html. A contrail change to either would quietly break the template: a page bug costing a run's figures, or a stale page published. #83 made every post-save failure exit 3; this records why it has to stay that way.Checks
./venv/bin/ruff check .and./venv/bin/ruff format .pass (no Python touched)./venv/bin/pytest -qpasses (no code touched)gh issue listfor open issues this change touches: noneTest plan
mdformat --checkandmarkdownlint-cli2pass ondocs/contrail-gh.mdsync.yml's Sync step writespassport_failed=trueon 3 and exits on any other non-zero;file_patternlistspassport.html;publish-passport.ymlstagespassport.html🤖 Generated with Claude Code
https://claude.ai/code/session_018Rk5Jex5dGPsKhePMEJeuV