initial docs

This commit is contained in:
Mark Chmarny 2020-06-18 14:53:56 -07:00
parent 105973d508
commit 71008c5541
2 changed files with 15 additions and 1 deletions

3
.gitignore vendored
View File

@ -14,3 +14,6 @@
# vendor
vendor
# docs
golang.org

View File

@ -1,6 +1,7 @@
RELEASE_VERSION =v0.8.0
GDOC_PORT =8888
.PHONY: mod test service client lint protps tag lint clean, help
.PHONY: mod test service client lint protps tag lint docs clean help
all: test
protos: ## Downloads proto files from dapr/dapr, generates gRPC clients
@ -27,6 +28,16 @@ client: mod ## Runs the uncompiled example client code
lint: ## Lints the entire project
golangci-lint run --timeout=3m
docs: ## Runs godoc (in container due to mod support)
docker run \
--rm \
-e "GOPATH=/tmp/go" \
-p 127.0.0.1:$(GDOC_PORT):$(GDOC_PORT) \
-v $(PWD):/tmp/go/src/ \
--name godoc golang \
bash -c "go get golang.org/x/tools/cmd/godoc && echo http://localhost:$(GDOC_PORT)/pkg/ && /tmp/go/bin/godoc -http=:$(GDOC_PORT)"
open http://localhost:8888/pkg/client/
tag: ## Creates release tag
git tag $(RELEASE_VERSION)
git push origin $(RELEASE_VERSION)