Skip to content

Creating releases

Chris Lasher edited this page Jan 25, 2024 · 6 revisions

Preparation

  • Ensure the CHANGELOG.md has all updates since the previous release. Follow the recommendations from https://keepachangelog.com/

  • Set a VERSION environment variable:

    export VERSION=5.0.4
    

    Substitute 5.0.4 for the correct version number of the format "<major>.<minor>.<patch>" (no v-prefix).

Tagging

Tag the appropriate commit with

git tag -am "Release $VERSION" v$VERSION

Push the tag with

git push --follow-tags

Create a GitHub Release

The GitHub CLI can help you quickly upload the artifacts and create the release:

gh release create v${VERSION} -t $VERSION

Add highlights of what has changed in the new release since the last; you can borrow from the Changelog.

Update the package repositories

Update the package repositories to point to the latest version and appropriate artifacts:

Clone this wiki locally