git release procedure

Release

Steps are as follows:

1. Create a release branch from develop, named release-<version>
2. Build release branch
3. Run through all available tests
4. Perform any fixes directly on the release branch
5. Repeat the two steps above until release is ready
6. Tag version file
7. Merge the release branch into master
8. Tag master with version number
9. Make a PR from release branch to develop
10. After PR is merged, delete release branch

Start the release

git checkout develop
git pull
git checkout -b release-1.0 develop

Build and make sure everything works (run through test procedure).

Apply any fixes in separate commits on the release branch.

Merge release into master

git checkout master
git merge --no-ff release-1.0 -m 'Release version 1.0'
git commit
git push

This will result in a merge commit on the master branch.

Tag master

git tag -a 1.0 -m 'Release version 1.0' master
git push --tags

Merge fixes into develop

git checkout develop
git merge release-1.0
git commit
git push

Changes in release branch must be merged into develop branch

Delete release branch

Wait until the eventual PR is merged before performing this step.

git branch -d release-1.0

Delete it in Github to delete it in the main repository.

Create release document

Create a release document with list of new features.