Skip to content

Release Management Guide

Lewis John McGibbney edited this page May 10, 2023 · 8 revisions

Release HOWTO

The following document should be followed for anyone wishing to release tagbase-server. The guide provides a example release for tagbase-server v0.3.0. We therefore use the following variables

old.version == v0.7.0 release.version == v0.8.0

Update release version

Change old.version to release.version as follows (works on macOS using zsh)

grep -ilr 'v0.7.0' * | xargs -I@ sed -i '' 's/v0.7.0/v0.8.0/g' @

Commit your changes to main branch.

Create a Tag for the Release

Create a tag with the following command (change the actual release.version)

git tag -a <release.version> -m "Tag tagbase-server <release.version>"

Push the tag to remote upstream canonical Github server

git push --tags

Create Github release

  • Navigate to tagbase-server/tags and (on the right hand side) create release.
  • On the next page name the release after the <release.version>.
  • Then Auto-generate release notes using the button with the same name. This will grab all the activity for the given tag and generate a clean release report. An example can be found here.
  • Scroll down and Publish release.

Conclusion

If all went well, you've successfully released tagbase-server... congratulations 🎉 🥳 🎉 .

If you have any issues please open an issue and tag it with release.

Clone this wiki locally