fix: rename binary to aerogear-app-metrics & update docs #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
darahayes
changed the title
paolobueno
reviewed
Feb 27, 2018
README.md
Outdated
| ``` | ||
| curl http://localhost:3000/healthz | ||
| docker-comose up |
paolobueno
reviewed
Feb 27, 2018
README.md
Outdated
| ``` | ||
| git tag -a v0.0.x -m "Release 0.0.x" | ||
| ``` | ||
| * `make build_linux` - Compiles a Linux compatible binary. This is mainly used for Docker builds. **Note:** `make build` should still be used if you are a Linux user. |
There was a problem hiding this comment.
I think the Note here is a bit confusing. Maybe better to just highlight that build_linux puts the binary in a different place.
paolobueno
reviewed
Feb 27, 2018
| * The code is built and the full test suite is run. | ||
| * The [goreleaser](https://goreleaser.com/) tool generates a Changelog and binaries for Windows, MacOS and Linux. These are added to the release created in Github. | ||
| * A new docker image is built and given the tags `latest` and `<git tag>` (where `<git tag>` is the `x.y.z` tag that was used). | ||
| * The docker image is pushed to the Aerogear organization in Github. |
There was a problem hiding this comment.
Not sure about capitalization for AeroGear, I see the 'g' in both lower and upper case in the website and other places, is there an official one?
For this repo we used AeroGear in CONTRIBUTING.md already.
There was a problem hiding this comment.
You're right, I think it's actually Aerogear. I've updated the Readme to only use this style.
There was a problem hiding this comment.
@matzew confirmed via IRC that it should be preferably 'AeroGear'
paolobueno
approved these changes
Feb 27, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR does two things:
metrics(which is unclear) toaerogear-app-metricsPing @paolobueno @aliok @david-martin