From 81d3281185f33105c0d7645c88309818ad922dc8 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 21 Jul 2021 14:32:54 -0400 Subject: [PATCH] Update RE doc (#1216) * DOC: Add warning in RE docs. * Add note to RE doc * fixup! --- docs/release-engineering.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/release-engineering.md b/docs/release-engineering.md index 8840ad525..1a75b6e1c 100644 --- a/docs/release-engineering.md +++ b/docs/release-engineering.md @@ -21,12 +21,12 @@ go version ## Step 2. Create a new release branch -From the "master" branch, run `bin/make-release.sh v1.2.3` where -"v1.2.3" should be the release version. +From the "master" branch, run `bin/make-release.sh v3.xx.y` where +"v3.xx.y" should be the new release version. NOTE: This warning can be ignored: `error: failed to push some refs to 'github.com:StackExchange/dnscontrol.git'` -The `make-release.sh` script will do a few things. +The `make-release.sh` script will do the following: 1. Tag the current branch locally and remotely. 2. Update main.go with the new version string. @@ -34,6 +34,8 @@ The `make-release.sh` script will do a few things. release notes. 4. Print instructions on how to create the release PR. +NOTE TO SELF: The last 2 times we did a release the tagging wasn't right. Be sure to watch this carefully, make sure the tag is handled correctly. (i.e. tag vx.y.z should be on release_vx.y.z) and update the docs with the correct procedure. + NOTE: If you bump the major version, you need to change all the source files. The last time this was done (v2 -> v3) these two commands automated all that: