mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: Make version a variable in rel eng doc (#2206)

Browse Source
This commit is contained in:
Tom Limoncelli
2023-03-22 01:10:08 -04:00
committed by GitHub
parent a08a4b3486
commit ecb0ecb62a
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
documentation/release-engineering.md
View File

@@ -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. 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) 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 ## Step 1. Rebuild generated files
```shell ```shell
export VERSION=v3.28.0
git checkout master git checkout master
git pull git pull
go generate go fmt ./...
go generate ./...
go mod tidy go mod tidy
git add -A git commit -a -m "Update generated files for $VERSION"
git commit -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 ## Step 2. Tag the commit in master that you want to release
```shell ```shell
git tag -a v3.20.0 export VERSION=v3.28.0
git tag -m "Release $VERSION" -a $VERSION
git push origin --tags git push origin --tags
``` ```