Skip to content

RELEASING.md

Latest commit

 

History

History
23 lines (12 loc) · 932 Bytes

RELEASING.md

File metadata and controls

23 lines (12 loc) · 932 Bytes

Releasing a new version

  1. Prepare a release by updating the changelog.

  2. Make sure you're on the main branch, and git pull to get the latest commits.

  3. Create a branch off main.

  4. Update CHANGELOG.md (in the root of the repo), moving current changes under Main to a new section for the version you are releasing.

    The changelog uses reference links to link each version's changes. Remember to add a link to the new version at the bottom of the file, and to update the link to [main].

  5. Push your branch and open a PR into main.

  6. Go to the Releases and Draft a new release.

  7. Choose a tag and create a tag for the new version.

  8. In the release notes, copy the changes from the changelog.

  9. Ensure the Title corresponds to the version we're publishing.

  10. Hit Publish release.