StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-01-11 18:08:57 +08:00
Code Issues Projects Releases Packages Wiki Activity

release-engineering.md: Small cleanups

Browse source
This commit is contained in:
Tom Limoncelli 2017-10-02 15:10:26 -04:00
parent 86e955befe
commit 56b4578833
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/release-engineering.md
View file

@ -1,6 +1,6 @@
# How to build and ship a release # How to build and ship a release
Here are my notes from producing the v0.1.5 release. Change the version number as appropriate. Here are my notes from producing the v0.2.2 release. Change the version number as appropriate.
## Step 1. Run the integration tests ## Step 1. Run the integration tests
@ -15,24 +15,24 @@ Edit the "Version" variable in `main.go` and commit.
``` ```
vi main.go vi main.go
git commit -m'Release v1.5' main.go git commit -m'Release v2.2' main.go
git tag v0.1.5 git tag v0.2.2
git push origin tag v0.1.5 git push origin tag v0.2.2
``` ```
## Step 3. Make the draft release. ## Step 3. Make the draft release.
[On github.com, click on "Draft a new release"](https://github.com/StackExchange/dnscontrol/releases/new) [On github.com, click on "Draft a new release"](https://github.com/StackExchange/dnscontrol/releases/new)
Pick the v0.1.5 tag Pick the v0.2.2 tag
Release title: Release v0.1.5 Release title: Release v0.2.2
Fill in the text box with something friendly like, "So many new features!" then make a bullet list of major new functionality. Fill in the text box with something friendly like, "So many new features!" then make a bullet list of major new functionality.
Review the git log using this command: Review the git log using this command:
git log v0.1.5...v0.1.0 git log v0.2.2...v0.1.5
Create the binaries and attach them to the release: Create the binaries and attach them to the release:
@ -40,7 +40,8 @@ Create the binaries and attach them to the release:
NOTE: This command creates binaries with the version number and git hash embedded. It also builds the releases for all supported platforms (i.e. creates a .exe for Windows even if you are running on Linux. Isn't Go amazing?) NOTE: This command creates binaries with the version number and git hash embedded. It also builds the releases for all supported platforms (i.e. creates a .exe for Windows even if you are running on Linux. Isn't Go amazing?)
WARNING: if there are unchecked in files, the version will have "dirty" added. WARNING: if there are unchecked in files, the version string will have "dirty" appended.
This is what it looks like when you did it right: This is what it looks like when you did it right:
@ -71,9 +72,9 @@ Email the mailing list: (note the format of the Subject line and that the first
``` ```
To: dnscontrol-discuss@googlegroups.com To: dnscontrol-discuss@googlegroups.com
Subject: New release: dnscontrol v0.1.5 Subject: New release: dnscontrol v0.2.2
https://github.com/StackExchange/dnscontrol/releases/tag/v0.1.5 https://github.com/StackExchange/dnscontrol/releases/tag/v0.2.2
So many new providers and features! Plus, a new testing framework that makes it easier to add big features without fear of breaking old ones. So many new providers and features! Plus, a new testing framework that makes it easier to add big features without fear of breaking old ones.