From ecb0ecb62a244bd362f151fe11255d46f1241865 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 22 Mar 2023 01:10:08 -0400 Subject: [PATCH] DOCS: Make version a variable in rel eng doc (#2206) --- documentation/release-engineering.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/documentation/release-engineering.md b/documentation/release-engineering.md index f93a68ff3..50b347262 100644 --- a/documentation/release-engineering.md +++ b/documentation/release-engineering.md @@ -5,27 +5,25 @@ These are the instructions for producing a release. CircleCI will do most of the work for you. You will need to edit the draft release notes. Please change the version number as appropriate. Substitute (for example) -`3.20.0` any place you see `VERSION` in this doc. +`v3.28.0` any place you see `$VERSION` in this doc. ## Step 1. Rebuild generated files ```shell +export VERSION=v3.28.0 git checkout master git pull -go generate +go fmt ./... +go generate ./... go mod tidy -git add -A -git commit -m "Update generated files for VERSION" +git commit -a -m "Update generated files for $VERSION" ``` -This will update the following generated files: - -* `commands/types/dnscontrol.d.ts` - ## Step 2. Tag the commit in master that you want to release ```shell -git tag -a v3.20.0 +export VERSION=v3.28.0 +git tag -m "Release $VERSION" -a $VERSION git push origin --tags ```