Skip to content

feat: deploy Gen2 docs website to stable URL from main#6086

Merged
rubencarvalho merged 4 commits intomainfrom
ruben/deploy-docs-website
Mar 24, 2026
Merged

feat: deploy Gen2 docs website to stable URL from main#6086
rubencarvalho merged 4 commits intomainfrom
ruben/deploy-docs-website

Conversation

@rubencarvalho
Copy link
Copy Markdown
Contributor

@rubencarvalho rubencarvalho commented Mar 18, 2026

Description

Adds a new GitHub Actions workflow (publish-2ndgen-docs.yml) that builds and deploys the 2nd-gen Storybook documentation to a stable Azure Blob Storage URL on every push to main. Uses azcopy sync with --delete-destination=true to keep the deployed files clean across deploys.

The docs are published to: https://swcpreviews.z13.web.core.windows.net/docs/

Note

Future: When we're ready for a custom domain, we can add an Azure CDN endpoint in front of the blob storage origin and map a domain to it. No workflow changes needed: the deploy target stays the same.

Motivation and context

PR previews already deploy 2nd-gen Storybook to per-PR paths in Azure, but there is no persistent deployment of the 2nd-gen docs from main. This workflow gives us a stable URL that is always up to date with the latest merged changes, reusing the existing Azure storage and authentication infrastructure.

Related issue(s)

  • SWC-1551

Screenshots (if appropriate)

N/A — CI workflow only.


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 N/A
  • I have added automated tests to cover my changes. N/A — CI config only
  • I have included a well-written changeset if my change needs to be published. No changeset needed — no package changes
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset N/A
  • Automated tests cover all use cases N/A
  • Validated on all supported browsers N/A
  • All VRTs are approved N/A

Manual review test cases

  • Verify workflow ran on push to branch

    1. Temporarily added this branch to the workflow's trigger branches and pushed
    2. Workflow ran successfully and deployed to https://swcpreviews.z13.web.core.windows.net/docs/
    3. Reverted the branch trigger before merging — workflow will only run on main pushes
  • Verify workflow runs on merge to main

    1. Merge this PR to main
    2. Check the Actions tab for the "Publish 2nd-Gen Documentation" workflow
    3. Expect it to complete successfully and deploy to https://swcpreviews.z13.web.core.windows.net/docs/
  • Verify manual trigger works

    1. Go to Actions > "Publish 2nd-Gen Documentation" > Run workflow
    2. Trigger on main
    3. Expect a successful deploy to the same URL

Device review

N/A — CI workflow only.

Accessibility testing checklist

N/A — CI workflow only, no UI changes.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 18, 2026

⚠️ No Changeset found

Latest commit: ba9e83a

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

@rubencarvalho rubencarvalho marked this pull request as ready for review March 18, 2026 17:01
@rubencarvalho rubencarvalho requested a review from a team as a code owner March 18, 2026 17:01
@rubencarvalho rubencarvalho added the Status:Ready for review PR ready for review or re-review. label Mar 18, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 18, 2026

📚 Branch Preview Links

🔍 First Generation 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-6086

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 the 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. label Mar 18, 2026
run: yarn build

- name: Build 2nd-gen Storybook
run: yarn workspace @spectrum-web-components/2nd-gen storybook:build
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nit: Why are you not calling yarn workspace @adobe/spectrum-wc storybook:build directly. The above is adding an extra hop.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated it!

Copy link
Copy Markdown
Contributor

@TarunAdobe TarunAdobe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good stuff

@rubencarvalho rubencarvalho requested a review from Rajdeepc March 24, 2026 07:34
Copy link
Copy Markdown
Contributor

@Rajdeepc Rajdeepc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@rubencarvalho rubencarvalho merged commit e73eb65 into main Mar 24, 2026
30 checks passed
@rubencarvalho rubencarvalho deleted the ruben/deploy-docs-website branch March 24, 2026 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants