From 733047c11baf2d3f9a8d9a85c7b899c12b4a8e75 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Mon, 6 Jul 2020 16:04:27 +0100 Subject: [PATCH] Releasing.md: Release tags are Release/A.B.C.D --- docs/Releasing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Releasing.md b/docs/Releasing.md index f82e98c3..bdb905e5 100644 --- a/docs/Releasing.md +++ b/docs/Releasing.md @@ -117,7 +117,7 @@ We'll use an old version number, 3.5.0.0, as an example throughout the following 1. You should have already decided on the new version number, as it's specified in `config.py`. You'll need to redo the `.msi` build if you forgot. **Remember to do a fresh git commit for this change.** -1. So as to make backing out any mistakes easier create a new branch for this release, e.g. `release-3.5.0.0`. 'release' is in full so as not to clash with the tag `rel-3.5.0.0` which could cause confusion. Ensure all the relevant commits, and no more than them, are present in this branch. +1. So as to make backing out any mistakes easier create a new branch for this release, using a name like `release-3.5.0.0`. Do not use the tag `Release/3.5.0.0` form, that could cause confusion. Ensure all the relevant commits, and no more than them, are present in this branch. 1. `git checkout releases` 1. `git pull origin` # Ensures local `releases` branch is up to date. 1. `git checkout -b release-3.5.0.0` @@ -134,7 +134,7 @@ Now get all the relevant code changes into this branch. This might mean merging 1. As you're working in a version-specific branch, `release-3.5.0.0`, you can safely commit these changes to git. **Do not merge the branch with `releases` until the github release is in place.** 1. Add a git tag for the release, which you'll refer to when actually creating the release: - 1. This should be named `rel-A.B.C.D`, e.g. `rel-3.5.0.0.` as per the version number. + 1. This should be named `Release/A.B.C.D`, e.g. `Release/3.5.0.0.` as per the version number. 1. Now push this release-specific branch to GitHub. 1. Check which of your remotes is for github with `git remotes -v`. It should really be `origin` and the following assumes that.