Skip to content

Commit 44fddc9

Browse files
authored
Merge pull request #260 from commitdev/release-instructions
Add release instructions to readme
2 parents e8a1301 + d974870 commit 44fddc9

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ $ zero init
8989
✔ EKS + Go + React + Gatsby
9090
✔ Should the created projects be checked into github automatically? (y/n): y
9191
✔ What's the root of the github org to create repositories in?: github.com/myapp-org
92-
✔ Existing AWS Profiles
92+
✔ Existing AWS Profiles
9393
✔ default
9494
9595
Github personal access token: used for creating repositories for your project
@@ -181,7 +181,7 @@ zero-deployable-backend:
181181
- Production API: api.commitzero.com
182182
```
183183

184-
***Your stack is now up and running, follow the links your terminal to visit your application 🎉***
184+
***Your stack is now up and running, follow the links your terminal to visit your application 🎉***
185185

186186

187187
## Zeros Default Stack
@@ -191,7 +191,7 @@ zero-deployable-backend:
191191
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)
192192
___
193193

194-
## Contributing to Zero
194+
## Contributing to Zero
195195

196196
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.
197197
@@ -210,6 +210,25 @@ To install the CLI into your GOPATH and test it, run:
210210
$ make install-go
211211
$ zero --help
212212
```
213+
214+
### Releasing a new version on GitHub and Brew
215+
216+
We are using a tool called `goreleaser` which you can get from brew if you're on MacOS:
217+
`brew install goreleaser`
218+
219+
After you have the tool, you can follow these steps:
220+
```
221+
export GITHUB_TOKEN=<your token with access to write to the zero repo>
222+
git tag -a <version number like v0.0.1> -m "Some message about this release"
223+
git push origin <version number>
224+
goreleaser release
225+
```
226+
227+
This will create a new release in GitHub and automatically collect all the commits since the last release into a changelog.
228+
It will also build binaries for various OSes and attach them to the release and push them to brew.
229+
The configuration for goreleaser is in [.goreleaser.yml](.goreleaser.yml)
230+
231+
213232
___
214233
## FAQ
215234
@@ -247,4 +266,4 @@ License: N/A
247266
[zeros vision]: https://docs.google.com/document/d/1YNRNgCfCHCxmIpD5ZsLYG2xCBxJLFd6CBI0DS_NFqoY/edit
248267
[project board]: [https://app.zenhub.com/workspaces/commit-zero-5da8decc7046a60001c6db44/board?filterLogic=any&repos=203630543,247773730,257676371,258369081]
249268
[Wget]: https://stackoverflow.com/questions/33886917/how-to-install-wget-in-macos
250-
[and more]: https://github.com/commitdev/zero-aws-eks-stack/blob/master/docs/resources.md
269+
[and more]: https://github.com/commitdev/zero-aws-eks-stack/blob/master/docs/resources.md

0 commit comments

Comments
 (0)