Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2.66 KB

RELEASE_PROCESS.md

File metadata and controls

40 lines (30 loc) · 2.66 KB
Raw

Releasing a new version of Spectrum Web Components

Users with permissions in the @spectrum-web-components organization on NPM can follow the following steps to create and publish a new version.

  1. Merge all pull requests to be included in the release and wait for the main branch to show that it has completed the required CI jobs.
  2. git checkout main && git fetch && git pull && git clean -dfX
  3. Run nvm use assumes a Node Version Manager install, and confirm your on an operable version of Node.
  4. yarn install
  5. npm whoami ensure that you are logged in with the user account for the public NPM registry
  6. yarn lerna-publish
  7. Scan the version summary for any unexpected changes.
    • Changes to the major versions number are likely to point to undesired version numbers.
    • Changes to the minor or feature version number should be confirmed as correct against the changes that have been made since the last release.
  8. Y to confirm.
  9. Enter one time password for npm.
  10. After the SWC packages are released, the React Wrapper packages will be generated. This multi-phase approach ensure that the wrapped packages share the same version as the standard packages.
  11. Scan the version summary for any unexpected changes.
    • The versions should be the same as those that just we applied to their matched SWC packages.
    • Changes to the major versions number are likely to point to undesired version numbers.
    • Changes to the minor or feature version number should be confirmed as correct against the changes that have been made since the last release.
  12. Y to confirm.
  13. Enter a new one time password for npm.

The docs site will publish automatically if the #publish string is included in the commit message and the check suite runs successfully.

If publishing fails with an error, check the list of tags to see if new tags have been released for your publishing attempt. If they have, then yarn lerna-publish will no longer work. Instead, you'll need to run:

yarn lerna-publish from-package

Publishing the docs site manually

Navigate to SWC's Actions and click the Build & publish site link under the Workflows heading.

At the top of the table you will see a Run workflow dropdown; click that and run it from the main branch.

Running manual workflows, GitHub documentation

If you have the GitHub CLI installed, you can alternatively run gh workflow run publish.yml --ref main from the command line.