Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.49 KB

release-process.md

File metadata and controls

39 lines (28 loc) · 2.49 KB

playground-elements Release Process

This document outlines the process for publishing playground-elements to npm.

Prerequisites:

  • Must have npm publish permissions for playground-elements. Note: it can take a few hours for the permissions to propagate and allow publishing.

Warning This release process has manual steps. At the ⚠️ emoji, proceed with caution.

Steps

  1. Manually create a release PR. Prior examples #264 #245
    1. Create a branch from main. E.g., git checkout -b release-vX-XX-X
    2. Modify the CHANGELOG.md to reflect the release version
    3. Run npm version --no-git-tag-version [patch|minor|major] to update package.json and package-lock.json with the correct version bump. This will also automatically run npm run update-version-module and stage the src/shared/version.ts file.
    4. Commit and create PR with name “Release <VERSION_NUMBER>”
  2. Get code review & tests passing on PR. Squash and merge once approved.
  3. Checkout the main branch and git pull. git status and git log to ensure on main and last commit was the release commit.

Warning Manual Publish to NPM - proceed with caution

  1. ⚠️ Running npm publish will always replace the latest tag with the version just published. The latest tag is what users get from npm install playground-elements. If publishing a pre-release, use npm publish --no-tag. Otherwise for a normal release, use npm publish.
  2. Check https://www.npmjs.com/package/playground-elements to validate that the publish succeeded, or run npm info playground-elements
  3. Add a Github Release via this dashboard.
    1. Press “Draft a new release”
    2. Click “Choose a tag” and type in the version that was released. You will create this new tag when publishing the release notes. It will be associated with the latest commit on main which is your release.
    3. Release title should be identical to the tag.
    4. In the “describe this release” textbox, copy paste the CHANGELOG.md for the release.
    5. Press “Publish release”.

Great job! You've successfully released playground-elements to npm and tagged the release.

Verification links: