ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish - #6637
ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish#6637blunteshwar wants to merge 2 commits into
Conversation
|
📚 Branch Preview Links🔍 Gen1 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
…-publish Splits the 2nd-gen docs deploy into two targets so the public site stays in sync with releases instead of updating on every merge: every push to main now syncs to $web/docs-staging/, while $web/docs/ (spectrum-web-components. adobe.com) deploys only on a manual workflow_dispatch or a push whose commit message contains #gen2-publish. The keyword avoids the #publish substring so it doesn't also trigger the Gen1 publish-docs-site workflow. Revives the work from #6507 (closed, unmerged) now that gen2 is moving into pre-release/beta publishing.
…docs trigger publish-2ndgen-docs.yml's production deploy step gates on the main push's commit message containing #gen2-publish, but that push is the squash-merge of the 2nd-gen Version PR, whose title was 'chore: release 2nd-gen packages (beta)' - no #gen2-publish substring. Squash merges use the PR title as the merge commit message (confirmed against this repo's own release-commit history), so the actual release event would never have carried the keyword and prod docs would silently never sync with a real gen2 release.
Description
Splits the 2nd-gen documentation deploy into two targets so the public site can stay in sync with releases instead of updating on every merge:
main(non-1st-gen changes) syncs to$web/docs-staging/(https://swcpreviews.z13.web.core.windows.net/docs-staging/). This preserves the always-latest environment we have today.$web/docs/(mapped tospectrum-web-components.adobe.com) now deploys only on a manualworkflow_dispatchor a push tomainwhose commit message contains#gen2-publish.The keyword is
#gen2-publishrather than#publishon purpose: the 1st-genpublish-docs-site.ymlmatches on the#publishsubstring, so a shared keyword would couple the two sites.#gen2-publishdoes not contain#publish, keeping them independent.publish-2nd-gen.yml's Version PR title now includes#gen2-publishtoo (chore: release 2nd-gen packages (beta) #gen2-publish) — the actual release event is the squash-merge of that PR, and squash merges use the PR title as the merge commit message onmain(confirmed against this repo's own release-commit history, e.g.chore: release packages #publish (#6470)). Without this, the keyword would only ever appear on a manualworkflow_dispatch, and the production docs site would never sync with a real gen2 release.Motivation and context
We're moving into pre-release/beta publishing and want the public 2nd-gen docs site to update in sync with announced releases, not on every merge. Staging keeps tracking
mainfor day-to-day validation.Rebased onto the current
release-strategybase (post gen1/gen2 changesets split in #6607) — the docs-deploy workflow itself is orthogonal to package publishing, but its production trigger needed to be wired to the actual release event under the new Version PR flow.Related issue(s)
Screenshots (if appropriate)
N/A — CI/documentation-deploy change only; no component or runtime UI is modified.
Author's checklist
if:gating logic and this repo's historical squash-merge commit messages.CONTRIBUTOR-DOCS/01_contributor-guides/06_releasing-swc.md).Reviewer's checklist
Manual review test cases
Staging deploys on merge
main.https://swcpreviews.z13.web.core.windows.net/docs-staging/reflects the change.Production deploys on a real gen2 release
chore: release 2nd-gen packages (beta) #gen2-publish) opened bypublish-2nd-gen.yml.maincontains#gen2-publish.spectrum-web-components.adobe.comreflects the change.Production deploys on manual dispatch
workflow_dispatch.No cross-trigger with 1st-gen
#gen2-publishcommit does not trigger Publish Documentation Site (1st-gen).Device review
Accessibility testing checklist
N/A — this PR only changes CI/documentation-deploy configuration; no component, page, or interactive surface is affected. No keyboard or screen reader testing applies.
Keyboard (required — document steps below)
Screen reader (required — document steps below)