From 68fdf90afc472e6a73ea77a9bfbb43f897ba2081 Mon Sep 17 00:00:00 2001
From: Sam Lai <sam@citymapper.com>
Date: Thu, 3 Jan 2019 11:35:31 +0000
Subject: [PATCH] Add release instructions to README

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 01cf0d6..6cbcc9a 100644
--- a/README.md
+++ b/README.md
@@ -28,3 +28,29 @@ Installation
 Notes:
 ------
 It requires a config file, see `config.yml`. Drop the `credentialsfile` parameter to use the [default AWS credentials chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials).
+
+Release
+-------
+
+go-minipypi uses [goreleaser](https://github.com/goreleaser/goreleaser) locally for releases.
+
+1. Install [goreleaser](https://goreleaser.com/install/)
+
+2. Ensure you're on a clean master, and tag the current commit for release -
+
+   ```sh
+   git tag -a "v0.4.0"
+   ```
+
+3. Do a dry-run of the release if necessary and check the artifacts in `dist/` -
+
+   ```sh
+   goreleaser --skip-publish
+   ```
+
+4. Export your GitHub token and complete the release -
+
+   ```sh
+   export GITHUB_TOKEN=your_github_token_with_release_privileges
+   goreleaser
+   ```