Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 5.16 KB

versioning.md

File metadata and controls

76 lines (60 loc) · 5.16 KB
Raw

Docs versioning

This site is configured to build its doc pages from a variable version of the content in the Storybook monorepo. This is mostly automated.

In this document, assume "latest" is 6.3 and "next" is 6.4.

"monorepo release branch" = main, next, and release-x-x (starting with release-6-0).

"frontpage release branch" = main and release-x-x (starting with release-6-0).

Publishing new versions

When a pre-release ("next") version (6.4, in this document) graduates to stable, and therefore a new "next" version (6.5, in this document) is cut:

First, in the monorepo:

Important: After each of these steps, cancel any Netlify deploys that are kicked off.

This is to avoid publishing any confusing states in the version selector.

  1. Create a release branch from main
    • release-6-3, in this document
  2. Delete the previous "next" release branch
    • release-6-4, in this document
    • This is done to maintain proper hygiene, as it would otherwise be the only release-x-x branch that doesn't serve a purpose
  3. Follow the normal monorepo release process for main and next branches
  4. Make sure all release branches, including main and next, have an appropriate version in their root package.json

Second, in this repo:

  1. Make sure each release branch in the monorepo has a corresponding release note, and that their contents are correct
    • But do not push these changes yet
  2. In the Netlify branch deploy setting:
    1. Add the version that was "latest"
      • release-6-3, in this document
    2. If present, remove the version that was "next" from the Netlify branch deploy setting
      • release-6-4, in this document
    3. If you would like to publish pre-release docs
      1. Add the version that will be "next" to the Netlify branch deploy setting
        • release-6-5, in this document
  3. Push any updates to main

🚨 IMPORTANT — Make sure all of the Netlify builds are successful, especially production.

If you make monorepo changes that require rebuilding all release branch deploys

e.g. updating "next" from 6.4.0-beta.30 -> 6.4.0-rc.0 would change the version label rendered in the VersionSelector, which is available on all deploys

You can kick off the push-all-release-branches workflow manually (against main). (More info)

How it works

  1. Pushing to a monorepo release branch triggers a workflow:
    • On push to main
      • Use webhook to kick off production frontpage deploy
    • On push to next
      • Creates & force-pushes release-6-4 branch
      • Sends dispatch event to this repo which kicks off a workflow to create and force-push release-6-4 branch
    • On push to release-x-x
      • If pushing to release-6-4
        • Warns that changes will be lost on next push to next
      • Else
        • Sends dispatch event to this repo which kicks off a workflow to create and force-push release-x-x branch
  2. Pushing those release-x-x branches in this repo will kick off a Netlify branch deploy for the appropriate version.
  3. When the docs content is extracted from the monorepo, each of the other version's info is extracted as well (for generating the list of available versions)
  4. Based on the latest and current version info, the site adjusts the URLs and other details appropriately. (See the PR for details.)
  5. Using Netlify proxy rewrites, the production site and branch deploys are stitched together to appear as a single site.

Keeping everything in sync

Pushing to main in this repo kicks off a workflow which will create new release branches from main and push them, kicking off branch deploys for each.

  • This ensures all branch deploys stay in-sync with any updates to production
  • If you're pushing a change to main that does not need to make corresponding changes to the release branch deploys, you can skip the workflow.