Skip to content

Fix docs_pages_workflow PEP 668 failure + gate it on PRs - #201

Merged
jaredgalloway merged 1 commit into
mainfrom
fix-docs-pep668
Jul 21, 2026
Merged

Fix docs_pages_workflow PEP 668 failure + gate it on PRs#201
jaredgalloway merged 1 commit into
mainfrom
fix-docs-pep668

Conversation

@jaredgalloway

Copy link
Copy Markdown
Member

Summary

Fixes the docs_pages_workflow failure that surfaced on main right after #200 merged.

Two changes:

  1. PEP 668 fix. Fix README badges: finish master→main migration and revive CI #200 moved the docs container off EOL debian:buster to debian:bookworm. Bookworm marks its system Python as externally managed (PEP 668), so pip install into it now fails with error: externally-managed-environment. Added --break-system-packages to the two pip calls — this job builds docs in a throwaway container, so a system-Python install is fine and keeps sphinx on PATH for docs/buildDocs.sh.
  2. Gate on PRs. This workflow previously triggered only on push to main, so its failure was not among Fix README badges: finish master→main migration and revive CI #200's PR checks and only appeared post-merge. Added a pull_request: branches: [main] trigger so a broken docs build blocks the PR going forward.

Test plan

  • This PR's own pull_request run of docs_pages_workflow is the live test — it must reach and pass the Install phippery step (previously the failure point) on debian:bookworm.

Deviations from spec

None — this is a direct follow-up fix, no separate spec. Chose --break-system-packages over a venv because buildDocs.sh expects sphinx on the system PATH; a venv would require threading its activation through that script too.

🤖 Generated with Claude Code

debian:bookworm (adopted when we moved off EOL debian:buster) marks its
system Python as externally managed per PEP 668, so `pip install` into it
now fails with 'externally-managed-environment'. Pass
--break-system-packages on the two pip calls — this job builds docs in a
throwaway container, so system-Python install is fine and keeps sphinx on
PATH for buildDocs.sh.

Also add a pull_request trigger: this workflow previously ran only on
push to main, so its failure slipped past PR #200's checks and only
surfaced after merge. Now a broken docs build gates the PR.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jaredgalloway
jaredgalloway merged commit 49281f1 into main Jul 21, 2026
6 checks passed
@jaredgalloway
jaredgalloway deleted the fix-docs-pep668 branch July 21, 2026 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant