release instructions (vmware-tanzu#403)

Signed-off-by: Chuck Ha <[email protected]> Signed-off-by: Jesse Hamilton [email protected] Signed-off-by: Jesse Hamilton [email protected]
jhamilton1 · Mar 28, 2018 · 20f0ad0 · 20f0ad0
1 parent 9e44704
commit 20f0ad0
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/release.md b/docs/release.md
@@ -0,0 +1,13 @@
+# Release
+
+## Steps to cut a release
+
+1. Bump the version defined in the code. As of the time of writing it is in
+   `pkg/buildinfo/version.go`.
+2. Commit and open a pull request.
+3. Create a tag after that pull request gets squashed onto master. `git tag -a
+   v0.11.1`.
+4. Push the tag with `git push --tags` (note this will push all tags). To push
+   just one tag do something like: `git push <remote> refs/tags/v0.11.1` where
+   `<remote>` refers to github.com/heptio/sonobuoy (this might be something like
+   `upstream` or `origin`). If you are unsure, use the first option.