____ ____
/ \/ \ |
| | ,--. ,--. .-- .--. |,--. ,---.
\::::::::::; | | | | | | | | | |---'
`:::::::;' '--| |--' | '--' '---' `---
`:::;' / |
`'
gprobe is a CLI client for the gRPC health-checking protocol.
Assuming server is listening on localhost:1234
Check server health (it is considered healthy if it has grpc.health.v1.Health
service and is able to serve requests)
gprobe localhost:1234
Check specific service health
gprobe localhost:1234 my.package.MyService
Get help
gprobe -h
Valid go environment is required to build gprobe
(go
is in PATH
, GOPATH
is set, etc.).
Clone code into valid GOPATH
location
git clone [email protected]:ncbi/gprobe.git $GOPATH/src/github.com/ncbi/gprobe
Build distributable tarballs for all OSes
make release
Build binary for current OS
make bin
This project follows git-flow branching model. All development is done off of the develop
branch. HEAD
in
production
branch should always point to a tagged release. There's no master
branch to avoid possible confusion.
To contribute:
- Fork or create a feature branch from the latest
develop
, commit your work theregit checkout develop git pull git checkout -b feature/<feature_description>
- Run
go fmt
and all the checks before committing any codego fmt ./... make lint test acctest
- When the change is ready in a separate commit update
CHANGELOG.md
describing the change. Follow keepachangelog guidelines - Create PR to develop
To release:
- Create a release branch from the latest
develop
and updateCHANGELOG.md
there, setting version and dategit checkout -b release/1.2.3
- Create PR to
production
- Once PR is merged, tag
HEAD
commit using annotated taggit tag -a 1.2.3 -m "1.2.3"
- Merge
production
back todevelop
. Do not usefast-forward
mergesgit checkout develop git merge --no-ff production