feat(ci): deploy default branch docs at /docs/execution-specs/#2973
Open
danceratopz wants to merge 2 commits into
Open
feat(ci): deploy default branch docs at /docs/execution-specs/#2973danceratopz wants to merge 2 commits into
danceratopz wants to merge 2 commits into
Conversation
Names the default branch in docs-branches.yaml and builds it with SITE_URL pointing at the product root (no <branch>/ segment), so canonical, OG, Twitter, and sitemap URLs match where steel-website publishes the artifact. Non-default branches keep the per-branch SITE_URL. Also drops devnets/bal/4 from the allowlist. Paired with the matching steel-website change that stages the default branch's artifact at /docs/execution-specs/ rather than /docs/execution-specs/<branch>/.
Computes SITE_URL in the Resolve publish configuration step and emits it as a job output. Replaces two separate default-vs-non-default conditionals (the publish-URL line in the job summary and the SITE_URL export in html-docs Build) with a single shared derivation. The html-docs Build step drops from 14 lines of conditional setup to 4 lines that just pass the precomputed value through to `just docs`. Same behavior, same SITE_URL values per branch / PR.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## forks/amsterdam #2973 +/- ##
================================================
Coverage 90.52% 90.53%
================================================
Files 535 535
Lines 32893 32893
Branches 3021 3021
================================================
+ Hits 29778 29780 +2
+ Misses 2596 2595 -1
+ Partials 519 518 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kclowes
approved these changes
Jun 11, 2026
kclowes
left a comment
kclowes
left a comment
Contributor
There was a problem hiding this comment.
I tested locally and this all looks good to me!
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
2 participants
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.
TLDR:
We currently deploy the default branch's docs (forks/amsterdam) at:
This PR and ethereum/steel-website#59 changes this to deploy at:
This is so that when we bump the default branch, the URL doesn't change: The most up-to-date version of the docs will always be available at https://steel.ethereum.foundation/docs/execution-specs/
Summary
default_branchfield to.github/configs/docs-branches.yamlto name the branch whose docs are deployed at the root of the product namespace on steel.ethereum.foundation (rather than under a<branch>/segment).docs-build.yamlto setSITE_URLwithout a<branch>/segment when building the default branch, so canonical, OG, Twitter, and sitemap URLs match where the artifact is actually published.devnets/bal/4from the allowlist (no longer required).Commits
feat(ci): deploy default branch docs at /docs/execution-specs/— the substantive change.refactor(ci): resolve SITE_URL once in check-should-publish— cleanup pass:SITE_URLis now derived once and emitted as a job output; the publish-summary line and the html-docs Build step both consume it. Replaces two separate default-vs-non-default conditionals. Same behavior, html-docs Build drops from 14 lines to 4.Why
Today the default development branch (currently
forks/amsterdam) ships atsteel.ethereum.foundation/docs/execution-specs/forks/amsterdam/. The URL becomes ephemeral at each fork rollover and the docs landing page has to recommendmainnetfor stable incoming links, which lags reality.Pairing this PR with the steel-website change moves the default branch's docs to
steel.ethereum.foundation/docs/execution-specs/, which is stable across rollovers and is the right URL to share. This PR is the upstream half: it ensuresSITE_URL(and therefore canonical/OG/sitemap URLs baked into the built HTML) matches the new publish path.Pairing
site/docs/execution-specs/instead ofsite/docs/execution-specs/<branch>/.Behavior
forks/amsterdam(default):SITE_URL=https://steel.ethereum.foundation/docs/execution-specs/.mainnet, other allowlisted branches:SITE_URL=https://steel.ethereum.foundation/docs/execution-specs/<branch>/(unchanged).SITE_URL=https://example.com/docs/<branch>/(unchanged).check-should-publishjob validates thatdefault_branchis present inbranches[]and fails fast on misconfiguration.