Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.24 KB

RELEASE_PROCESS.md

File metadata and controls

46 lines (27 loc) · 2.24 KB
Raw

How to cut a ponyup release

This document is aimed at members of the team who might be cutting a release of ponyup. It serves as a checklist that can take you through doing a release step-by-step.

Prerequisites

  • You must have commit access to the ponyup repository.
  • It would be helpful to have read and write access to the ponylang cloudsmith account.

Releasing

Please note that this document was written with the assumption that you are using a clone of the ponyup 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 ponyup repo from which you will release.

git clone [email protected]:ponylang/ponyup.git ponyup-release-clean
cd ponyup-release-clean

Before 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 main branch of this repository. At this time, releasing from any other location is not supported.

For the duration of this document, 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.1

If something goes wrong

The release process can be restarted at various points in it's lifecycle by pushing specially crafted tags.

Start a release

As documented above, a release is started by pushing a tag of the form release-x.y.z.

Build artifacts

The release process can be manually restarted from here by pushing a tag of the form x.y.z. The pushed tag must be on the commit to build the release artifacts from. During the normal process, that commit is the same as the one that release-x.y.z.

Announce release

The release process can be manually restarted from here by push a tag of the form announce-x.y.z. The tag must be on a commit that is after "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 ponyup 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.