This document is aimed at members of the team who might be cutting a release of pony-protobuf. It serves as a checklist that can take you through doing a release step-by-step.
- You must have commit access to the pony-protobuf repository.
Please note that this document was written with the assumption that you are using a clone of the pony-protobuf repo. You have to be using a clone rather than a fork. It is advised to your do this by making a fresh clone of the pony-protobuf repo from which you will release.
git clone [email protected]:ergl/pony-protobuf.git pony-protobuf-release-clean
cd pony-protobuf-release-cleanBefore getting started, you will need a number for the version that you will be releasing as well as an agreed upon "golden commit" that will form the basis of the release.
The "golden commit" must be HEAD on the default branch (currently main) of this repository. At this time, releasing from any other location is not supported.
For the duration of this document, imagine that we are releasing version is 0.3.1. Any place you see those values, please substitute your own version.
git tag release-0.3.1
git push origin release-0.3.1The release process can be restarted at various points in its life-cycle by pushing specially crafted tags.
As documented above, a release is started by pushing a tag of the form release-x.y.z.
The release process can be manually restarted from here by pushing a tag of the form announce-x.y.z. The tag must be on a commit that is after the "Release x.y.z" commit that was generated during the Start a release portion of the process.
If you need to restart from here, you will need to pull the latest updates from the pony-protobuf repo as it will have changed and the commit you need to tag will not be available in your copy of the repo with pulling.