refactor(docs): replace docs-spec-parallel bash with a Python planner#24
Open
danceratopz wants to merge 3 commits into
Open
refactor(docs): replace docs-spec-parallel bash with a Python planner#24danceratopz wants to merge 3 commits into
danceratopz wants to merge 3 commits into
Conversation
Move the `docs-spec-parallel` shard math and process fan-out from an inline bash block into `ethereum_spec_tools.docc_shards`, run via `python -m`; the recipe is now a one-line delegation. The integer sharding and subprocess handling read more clearly as Python. Three review points the move resolves for free: - Fail loudly on empty fork discovery instead of exiting 0 having validated nothing. - Unit test `compute_shards` for full coverage and one-fork overlap. - Invoke as a module, so no console script lands on local users' PATH. A successful build is unchanged: same shards, same per-shard output.
danceratopz
commented
Jul 6, 2026
| # Build spec docs in parallel shards of consecutive forks (PR validation). | ||
| # Each shard overlaps its predecessor fork by one so every previous-fork | ||
| # reference is validated in some shard; outputs are per-shard and not merged. | ||
| # Build spec docs in parallel shards for fast PR validation |
Author
There was a problem hiding this comment.
This is the recipe documentation; it should be a single-line comment for clean shell output.
4 tasks
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
1 participant
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.
🗒️ Description
Follow-up to the
docs-spec-parallelrecipe added in ethereum#3101. It moves the shard math and process fan-out out of the inline bash block intoethereum_spec_tools.docc_shards, invoked viapython -m, leaving the recipe a one-line delegation. The integer sharding, array slicing, and subprocess handling read far more clearly in Python, and the shard planner (compute_shards) is now unit tested. A successful build is unchanged: Identical shards, identical per-shard output underdocs-spec-parallel/shard-N.The move also resolves three review points at no extra cost. It exits non-zero when fork discovery returns nothing, where the bash form exited
0having validated nothing (a false green on a validation gate); it unit tests the coverage and one-fork-overlap invariants that were previously only eyeballed in bash; and it runs as a module rather than a console script, so nothing new lands on local users'PATH.🔗 Related Issues or PRs
Builds on ethereum#3101.
✅ Checklist
just static<type>(<area>):, where<type>and<area>come from an approrpriateC-<type>, respectivelyA-<area>, label. The title should match the a target squash commit message.Cute Animal Picture