From d974870fc5413b61062d6ce9ab4d8b52b62fd523 Mon Sep 17 00:00:00 2001 From: Bill Monkman Date: Wed, 26 Aug 2020 13:51:51 -0700 Subject: [PATCH] Add release instructions to readme --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 596c29970..99c0eec6e 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ $ zero init ✔ EKS + Go + React + Gatsby ✔ Should the created projects be checked into github automatically? (y/n): y ✔ What's the root of the github org to create repositories in?: github.com/myapp-org -✔ Existing AWS Profiles +✔ Existing AWS Profiles ✔ default Github personal access token: used for creating repositories for your project @@ -181,7 +181,7 @@ zero-deployable-backend: - Production API: api.commitzero.com ``` -***Your stack is now up and running, follow the links your terminal to visit your application 🎉*** +***Your stack is now up and running, follow the links your terminal to visit your application 🎉*** ## Zeros Default Stack @@ -191,7 +191,7 @@ zero-deployable-backend: If you would like to learn more about the zero-aws-eks stack, you can read more about it [here](https://github.com/commitdev/zero-aws-eks-stack) ___ -## Contributing to Zero +## Contributing to Zero Zero welcomes collaboration from the community; you can open new issues in our GitHub repo, Submit PRs' for bug fixes or browse through the tickets currently open to see what you can contribute too. @@ -210,6 +210,25 @@ To install the CLI into your GOPATH and test it, run: $ make install-go $ zero --help ``` + +### Releasing a new version on GitHub and Brew + +We are using a tool called `goreleaser` which you can get from brew if you're on MacOS: +`brew install goreleaser` + +After you have the tool, you can follow these steps: +``` +export GITHUB_TOKEN= +git tag -a -m "Some message about this release" +git push origin +goreleaser release +``` + +This will create a new release in GitHub and automatically collect all the commits since the last release into a changelog. +It will also build binaries for various OSes and attach them to the release and push them to brew. +The configuration for goreleaser is in [.goreleaser.yml](.goreleaser.yml) + + ___ ## FAQ @@ -247,4 +266,4 @@ License: N/A [zeros vision]: https://docs.google.com/document/d/1YNRNgCfCHCxmIpD5ZsLYG2xCBxJLFd6CBI0DS_NFqoY/edit [project board]: [https://app.zenhub.com/workspaces/commit-zero-5da8decc7046a60001c6db44/board?filterLogic=any&repos=203630543,247773730,257676371,258369081] [Wget]: https://stackoverflow.com/questions/33886917/how-to-install-wget-in-macos -[and more]: https://github.com/commitdev/zero-aws-eks-stack/blob/master/docs/resources.md \ No newline at end of file +[and more]: https://github.com/commitdev/zero-aws-eks-stack/blob/master/docs/resources.md