Merge pull request #14 from urbanopt/feat/docs

docs: add release instructions

.goreleaser.yml

@@ -30,6 +30,7 @@ changelog:
     - '^docs:'
     - '^test:'
 release:
+  draft: true
   # If set to auto, will mark the release as not ready for production
   # in case there is an indicator for this in the tag e.g. v1.0.0-rc1
   # If set to true, will mark the release as not ready for production.

docs/release.md

@@ -0,0 +1,14 @@
+# Releases
+Modelica formatter uses [GoReleaser](https://goreleaser.com/) for building assets and documenting tags for release. This is run automatically by Travis CI whenever a new tag is pushed to remote. See [.goreleaser.yml](/.goreleaser.yml) and [.travis.yml](/.travis.yml) for the configuration.
+
+## How to make a release
+First, create a tag:
+```bash
+git tag -a v<version> -m "<message>" [SHA]
+```
+Where `v<version>` is a valid [semantic version](https://semver.org/) (e.g. `v1.2` or `v1.2-pr.1`) and `<message>` is the tagging message (e.g. "First official release")
+
+Next, push the tag up to remote, triggering a Travis build which runs GoReleaser:
+```bash
+git push origin v<version>
+```