Release Checklist

Jump to bottom Edit New page

Nick Satterly edited this page Mar 18, 2023 · 18 revisions

Release Checklist

Release steps for API...

update CHANGELOG run...

$ cz ch --incremental --unreleased-version vX.Y.Z

bump VERSION and alerta/version.py files
git commit to master

$ git commit -m 'Bump version A.B.C -> X.Y.Z'
$ git push

Check all tests pass
tag commit with "vX.Y.Z" and push to trigger upload to PyPI

$ git tag -a vX.Y.Z -m 'version X.Y.Z'
$ git push --follow-tags

Verify auto-deploy to fly.io

https://alerta-api.fly.dev/management/status

cut github release

https://github.com/alerta/alerta/releases

Release steps for CLI...

update CHANGELOG run...

$ cz ch --incremental --unreleased-version vX.Y.Z

bump VERSION and alertaclient/version.py files
git commit to master

$ git commit -m 'Bump version A.B.C -> X.Y.Z'
$ git push

Check all tests pass
tag commit with "vX.Y.Z" and push to trigger upload to PyPI

$ git tag -a vX.Y.Z -m 'version X.Y.Z'
$ git push --follow-tags

cut github release

https://github.com/alerta/python-alerta-client/releases

Release steps for web UI

bump version in package.json and package-lock.json
git add and commit
git tag alerta webui release
git push --follow-tags (wait for build artifact to be uploaded)
cut github release https://github.com/alerta/alerta-webui/releases
check auto-deploy to https://beta.alerta.io
deploy to heroku https://alerta.herokuapp.com

Release steps for Docker

bump VERSION
git commit, tag and push

Release steps for deployments

deploy to Heroku public API
bump docker-alerta repo VERSION file https://github.com/alerta/docker-alerta/releases
trigger docker build for new VERSION https://cloud.docker.com/u/alerta/repository/docker/alerta/alerta-web

Documentation

Release notes in each github repo
release notes on docs.alerta.io
update docs.alerta.io
mention new release on Gitter
update alerta.io landing page

Help

To tag a release run:

$ git tag -a v6.3.1 -m 'version 6.3.1'
$ git push --tags

or use the make shortcut:

$ make tag