From e11a4587f89b532a34f84946416f63254f27ae8a Mon Sep 17 00:00:00 2001 From: Jacques Coney Date: Fri, 20 Sep 2019 12:53:36 +0100 Subject: [PATCH] updated readme around releasing --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b5152d4..50d4a3e 100644 --- a/README.md +++ b/README.md @@ -72,3 +72,17 @@ See `examples/config.json` } } ``` + +## Development + +### Release + +Releases are managed using [goreleaser](https://github.com/goreleaser/goreleaser). + +To release: +- Tag the commit you want to release, e.g. `git tag v0.1.1` +- run `make release` + +You will need a github personal access token bound to env var `GITHUB_TOKEN` + +You can dry run the release by running `make test-release`