dnscontrol/docs/release-engineering.md

91 lines
2.6 KiB
Markdown
Raw Normal View History

# How to build and ship a release
2017-10-03 03:10:26 +08:00
Here are my notes from producing the v0.2.2 release. Change the version number as appropriate.
## Step 1. Run the integration tests
2017-10-03 01:53:01 +08:00
* If you are at StackOverflow, this is in TC as "DNS > Integration Tests".
* Otherwise:
* Run "go test" (documented in [Creating new DNS Resource Types](adding-new-rtypes))
* Run the integration tests (documented in [Writing new DNS providers](writing-providers)
## Step 2. Bump the verison number
Edit the "Version" variable in `main.go` and commit.
```
vi main.go
2017-10-03 03:10:26 +08:00
git commit -m'Release v2.2' main.go
git tag v0.2.2
git push origin tag v0.2.2
```
## Step 3. Make the draft release.
[On github.com, click on "Draft a new release"](https://github.com/StackExchange/dnscontrol/releases/new)
2017-10-03 03:10:26 +08:00
Pick the v0.2.2 tag
2017-10-03 03:10:26 +08:00
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.
Review the git log using this command:
2017-10-03 03:10:26 +08:00
git log v0.2.2...v0.1.5
Create the binaries and attach them to the release:
2017-08-30 01:49:39 +08:00
go run build/build.go
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?)
2017-10-03 03:10:26 +08:00
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:
```
$ ./dnscontrol-Darwin version
2017-08-25 00:04:33 +08:00
dnscontrol 0.1.5 ("6fdf78997815055bbe119c0116c9e2d60310a515") built 24 Aug 17 11:26 EDT
```
This is what it looks like when there was a file that should have been checked in:
```
$ ./dnscontrol-Darwin version
dnscontrol 0.1.5 ("6fdf78997815055bbe119c0116c9e2d60310a515[dirty]") built 24 Aug 17 11:27 EDT
^^^^^
^^^^^ See?
^^^^^
```
## Step 4. Attach the binaries and release.
Drag and drop binaries into the web form.
Submit the release.
## Step 5. Announce it
Email the mailing list: (note the format of the Subject line and that the first line of the email is the URL of the release)
```
To: dnscontrol-discuss@googlegroups.com
2017-10-03 03:10:26 +08:00
Subject: New release: dnscontrol v0.2.2
2017-10-03 03:10:26 +08:00
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.
* list
2017-08-30 01:49:39 +08:00
* of
* major
* changes
```
## Step 6. Get credit!
Mention the fact that you did this release in your weekly accomplishments.