You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
ci/docs: stop committing generated aggregate docs in PRs (oracle_assumptions.md et al.): render post-merge to the generated branch #5057
Problem (churn throughput): parallel PRs keep conflicting on generated aggregate docs that every PR re-renders and commits. Over the last 3 days on main:
Example: #5038 and #5041 both went dirty after #5035 merged, on oracle_assumptions.md (and a comment line), and sat for hours. Every conflict costs a worker run plus a CI cycle.
Direction (same pattern as #4963, which moved the ground-truth history and evidence report to the generated branch):
PRs commit sources only (register entries, spec tables, ledgers' inputs). The aggregate pages are no longer committed in PRs.
CI on a PR checks that the render succeeds and is deterministic (render to a temp dir; fail on error or on a source the renderer can't place), and posts the rendered diff as an artifact or job summary, so a reviewer still sees the effect.
Remove the "generated file is stale" gates for those files from pr_gates, and replace them with the render check from step 2.
Class sweep: list every generated, committed file (git grep -l "GENERATED\|do not edit" -- docs), and decide per file: move, or keep committed with a reason (e.g. it is read by code at runtime). Put the table in the PR.
Acceptance: two PRs that each add a register entry merge in either order with no conflict; the published pages match a fresh render of main; no workflow writes to main.
Owner asked for this (2026-10-13: "software factory" improvements, item 5). Workflow edits allowed.
Activity
generated-docs.yml: check out under gitgalaxy/ so the pip cache key i…
generated-docs.yml: a PR touching generated_branch.py runs it too (#5057
Generated aggregate docs: render in CI, publish to `generated`, never…