Skip to content

[DO-NOT-MERGE] ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish - #6507

Open
rubencarvalho wants to merge 2 commits into
mainfrom
rcarvalho/ci-gen2-docs-staging-publish
Open

[DO-NOT-MERGE] ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish#6507
rubencarvalho wants to merge 2 commits into
mainfrom
rcarvalho/ci-gen2-docs-staging-publish

Conversation

@rubencarvalho

@rubencarvalho rubencarvalho commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Warning

Do not merge before we release / announce our beta publicly.

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:

  • Staging — every push to 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.
  • Production$web/docs/ (mapped to spectrum-web-components.adobe.com) now deploys only on a manual workflow_dispatch or a push to main whose commit message contains #gen2-publish.

The keyword is #gen2-publish rather than #publish on purpose: the 1st-gen publish-docs-site.yml matches on the #publish substring, so a shared keyword would couple the two sites. #gen2-publish does not contain #publish, keeping them independent.

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 main for day-to-day validation.

Related issue(s)

  • fixes [N/A]

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Manual review test cases

  • Staging deploys on merge

    1. Merge a non-1st-gen change to main.
    2. Confirm Publish 2nd-Gen Documentation runs the "Deploy to staging" step and skips "Deploy to production".
    3. Verify https://swcpreviews.z13.web.core.windows.net/docs-staging/ reflects the change.
  • Production deploys on keyword

    1. Merge a change to main with #gen2-publish in the commit message (or run the workflow manually).
    2. Confirm both "Deploy to staging" and "Deploy to production" run.
    3. Verify spectrum-web-components.adobe.com reflects the change.
  • No cross-trigger with 1st-gen

    1. Confirm a #gen2-publish commit does not trigger Publish Documentation Site (1st-gen).

Accessibility testing checklist

CI/documentation-deploy change only; no component or runtime UI is modified.

  • Keyboard (required — document steps below)

    1. N/A — no focusable UI is added or changed by this workflow/docs update.
  • Screen reader (required — document steps below)

    1. N/A — no roles, names, or announcements are affected by this workflow/docs update.

@rubencarvalho
rubencarvalho requested a review from a team as a code owner July 14, 2026 13:32
@changeset-bot

changeset-bot Bot commented Jul 14, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: e31ee45

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

📚 Branch Preview Links

🔍 Gen1 Visual Regression Test Results

When 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: pr-6507

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@rubencarvalho rubencarvalho added Status:Ready for review PR ready for review or re-review. and removed ready-for-review labels Jul 14, 2026
@rubencarvalho rubencarvalho added the skip_vrt Skip VRT build; mark UI Tests green without running Chromatic label Jul 14, 2026
@coveralls

coveralls commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 29337832932

Warning

No base build found for commit de28723 on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 96.257%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 39169
Covered Lines: 37903
Line Coverage: 96.77%
Relevant Branches: 6457
Covered Branches: 6015
Branch Coverage: 93.15%
Branches in Coverage %: Yes
Coverage Strength: 461.45 hits per line

💛 - Coveralls

@rubencarvalho rubencarvalho added the do-not-merge NO MERGE-Y! label Jul 14, 2026
@rubencarvalho rubencarvalho changed the title ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish [DO-NOT-MERGE] ci(docs): stage 2nd-gen docs on merge, gate prod publish behind #gen2-publish Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge NO MERGE-Y! skip_vrt Skip VRT build; mark UI Tests green without running Chromatic Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants