Merge branch 'release-instructions' into 'master'

Adding a checklist what to do for cutting a release

See merge request tarmak/tarmak!84

Author: Matt Bates

CHANGELOG.md

@@ -12,13 +12,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## 0.1.2 - 2017-10-19
 
-### Initial release
+### Initial release (*alpha*)
 - First public release
 - Support for AWS provider only
 - Prepare and drive infrastructure updates using Terraform
 - Prepare configuration updates using Puppet and drive them using Wing on the
   instances
 - Provides wrappers for basic administrative task: kubectl, ssh
+- Experimental vendoring of Kubicorn's Cluster API (https://github.com/kris-nova/kubicorn) for cluster configuration
 
 > Disclaimer - please note that current releases of Tarmak are alpha (unless
 > explicitly marked). Although we do not anticipate breaking changes, at this

docs/developer-guide.rst

@@ -66,3 +66,23 @@ To build the documentation run the following.
   make html
 
 You can now open `_build/html/index.html` in a browser.
+
+
+Release Checklist
+-----------------
+
+This is a list to collect manual tasks/checks necessary for cutting a
+release of Tarmak:
+
+Before tagging a release:
+
+* Update the CHANGELOG
+* Ensure Wing release is updated in Terraform (not easily possible as we
+  protect the download by the hash we don't know yet, `#8
+  <https://github.com/jetstack/tarmak/issues/8>`_)
+* Branch out minor releases into ``release-x.y``
+* Tag release commit with ``x.y.z``
+
+After release job has run:
+
+* Make sure we update the generated `releases <https://github.com/jetstack/tarmak/releases>`_ page