Merge pull request #441 from blgm/releasing

Add a `RELEASING.md` guide for creating a release
onsi · Mar 21, 2018 · 03ffd3f · 03ffd3f
2 parents 4177ca8 + 79d812b
commit 03ffd3f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,8 @@
+A Ginkgo release is a tagged git sha and a GitHub release.  To cut a release:
+
+1. Ensure CHANGELOG.md is up to date.
+1. Update `VERSION` in `config/config.go`
+1. Create a commit with the version number as the commit message (e.g. `v1.3.0`)
+1. Tag the commit with the version number as the tag name (e.g. `v1.3.0`)
+1. Push the commit and tag to GitHub
+1. Create a new [GitHub release](https://help.github.com/articles/creating-releases/) with the version number as the tag  (e.g. `v1.3.0`).  List the key changes in the release notes.