Skip to content

How to release

Jump to bottom
Akshita edited this page Feb 4, 2021 · 4 revisions

How to do a release

The release process

Ok, the release process with our new triggering of the pipeline made releasing a lot easier.

  1. Find the changes since last release for the release description

The command git log <last release>..HEAD is useful to print all changes since last release. You can add --merges --first-parent to the git log command to only show merge commits. --reverse is helpful too. That is: git log <last release>..HEAD --merges --first-parent --reverse

Another approach is to get a list of merged pull-request since the last release: find the merged pull-request of the previous release, note the date when that happened, and then paste the following into the "Filter" field in the "Pull requests" tab on GitHub: is:pr is:closed merged:>YYYY-MM-DD where YYYY-MM-DD should be replaced by the date of the merge of the pull-request of the previous release.

Save this information in a changelog text file.

  1. Github release the package

Make a release on GitHub:

Go to Code->Releases->Draft a new release, choose Target: main as the release branch and copy changelog into the description, give the release a title that is consistent with previous releases, use v<version> as a tag (notice the v; for example, v0.8.0). Save as draft Make sure that CI passes. Re-run the pipeline if you're in doubt. Click publish to publish the release

  1. Finally put an announcement with links to the changelog in Slack, Teams, and elsewhere.

Clone this wiki locally