Skip to content

docs(contrail-gh): record the template's reliance on sync --passport - #85

Merged
atdr merged 1 commit into
mainfrom
docs/contrail-gh-passport-contract
Oct 13, 2026
Merged

atdr merged 1 commit into
mainfrom
docs/contrail-gh-passport-contract

Conversation

@atdr

@atdr atdr commented Oct 13, 2026

Copy link
Copy Markdown
Owner

What changed

docs/contrail-gh.md gains an obligations-table row for sync --passport's exit codes and Passport's default path, and its Passport paragraph now says the template builds the page with contrail sync --passport and can opt in to publishing it with publish-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.yml treats exit 3 as "log saved, page failed" and commits anyway, and stops before the commit on any other non-zero. Its file_pattern and publish-passport.yml (atdr/contrail-gh#23) both expect passport.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 -q passes (no code touched)
  • Docs updated in this PR, if this changes a config option, an importer, or an emissions provider (n/a: docs only)
  • Tests added or updated, if this changes behaviour (n/a)
  • Skimmed gh issue list for open issues this change touches: none

Test plan

  • mdformat --check and markdownlint-cli2 pass on docs/contrail-gh.md
  • The row's claims match the template as merged: sync.yml's Sync step writes passport_failed=true on 3 and exits on any other non-zero; file_pattern lists passport.html; publish-passport.yml stages passport.html

🤖 Generated with Claude Code

https://claude.ai/code/session_018Rk5Jex5dGPsKhePMEJeuV

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
@atdr atdr added the documentation Improvements or additions to documentation label Oct 13, 2026
@atdr
atdr merged commit 474342f into main Oct 13, 2026
16 checks passed
@atdr
atdr deleted the docs/contrail-gh-passport-contract branch October 13, 2026 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant