Skip to content

releases.md

Latest commit

 

History

History
25 lines (14 loc) · 1.2 KB

releases.md

File metadata and controls

25 lines (14 loc) · 1.2 KB

Releases

For maintainers, how to release a new version of @mavenlink/design-system:

  1. Create a Release Branch

    Create a new branch (format: release-x.y.z) from master to contain your release changes, which should only include changelog and version change.

  2. Update the changelog

    As components are added and modified, updates should be added to the "unreleased" section of the changelog. Now we should move all items from the "unreleased" section to a new section in the changelog with the current date and the new version number). For example, see this example commit. Commit this change.

  3. Publish to NPM

    Use yarn publish, which will ask for your NPM credentials and a new version.

  4. Create a Release PR

    Create a new PR in github with the release tag targeted at master, and merge with success/approval as normal.

  5. Tag a new release

    Draft and publish a new release in Github.

    • Copy over the changelog section title as the release title
    • Copy over the changelog section items as the release body