This documents explains how to a release:
- You need a GPG key! If you don't have one, create one.
- You need an access token for gitlab, create one and keep it safe.
To do a release X.Y.Z do the following steps:
make start-release VER=vX.Y.Z
- edit
ChangeLog
and rename it to TAGMESSAGE` make complete-release VER=vX.Y.Z ACCESS_TOKEN=<your-secret-key>
If you encountered merge conflicts, you need to fix them first and then proceed manually:
Below assumes you are on
master
after merging the branchprepare_${VER}
.
- Create a tag:
git tag -f -s ${VER} -F TAGMESSAGE
- Un-protect the
master
branch:python3 tests/scripts/protect-un-protect.py master
Make sure the output saysSuccessfully removed protection of master
- Push to
master
:git push origin master --tags
- Re-protect the
master
branch:python3 tests/scripts/protect-un-protect.py master
- Finish the release:
make -f release.mk finish-release VER=vX.Y.Z
If for some reason you encounter an error in any of the stages, you can do:
make abort-release VER=vX.Y.Z