releases.md

Releases

Prerequisites

• Create an NPM account
• Enable 2FA on the NPM account for authorization and publishing
• Reach out to @juanca for access to the Mavenlink org

How-to

1. Create a release branch (format: vX.Y.Z) from latest master.

2. Update the changelog:

   make a new section titled vX.Y.Z; move all items from the "unreleased" section to it; stage these changes.

3. Publish to NPM with yarn publish. Note: this will create a commit and tag with the staged changelogs and semver change.

4. git push origin HEAD --set-upstream --tags to persist your new branch and version tag to Github.

5. Create a PR

6. After merging the PR, 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