This document is to guide anyone allowed to write to the main Uplift repository to assist in releasing
- Prerequisite:
You need the following environment variables set to be able to make the release:
Key | Expected value | Description |
---|---|---|
UPLIFT_GITHUB_TOKEN | A valid Github token with read permission for the Uplift repository | This is the token used to create the release PR, and the release on Github. |
- Bumping the version:
rake bump
The first step is to describe which version you are going to release. You will be asked to input the newer version.
- Preparing the release:
rake pre_release
Next you need to prepare the next release: make sure that the git is clean, generate the changelog and create a pull request for the release.
NOTE: You should approve and merge the PR before going to the next step
- Actually releasing the project:
rake release
This creates a draft for a release, with a title, a changelog and builds and attach the .unitypackages
files for the target versions to the release.
NOTES:
. The release is only drafted and you need to accept it before it is available to the public
. Because we build on several targets, git may not be clean as Unity could have updated some scripts when switching API (this is for example the case between 5.6.5f1
and 2017.1.2f1
). You will probably need to git checkout
some modifications!