Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.85 KB

releases.md

File metadata and controls

28 lines (18 loc) · 1.85 KB

How to version and publish frontend-shared

Summary

  1. Update the package version in package.json and merge that change into the main branch1. We use Semantic Versioning.
  2. Create a tag pointing at the version-change commit and generate a new GitHub release (details follow). Publishing a GitHub release will kick off a GitHub Action that will do the following:

Creating a GitHub release

Create a new GitHub release with these values:

  1. Tag: Create a new tag for the release, targeting the main branch (your just-merged version bump should be at the tip)2. The tag should match the version number, e.g. v5.2.1.
  2. Title: Use the tag name.
  3. Click the Auto-generate release notes button to generate release notes and edit as needed. We use Keep a Changelog formatting.3
  4. Leave other fields alone/as defaults.

Verify the release

Footnotes

  1. Unlike other PRs, a version-bump PR does not require review. But do wait for CI to complete first.

  2. You can create a tag manually as a separate step if you want to tag a non-tip commit.

  3. You can look at release notes for other recent releases as exemplars. You don't need to include every change (especially, e.g., dependency updates).