zecfoundation
/
lightwalletd
mirror of https://github.com/ZcashFoundation/lightwalletd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

auto-generate docs and .pb.go files if .proto changes

This commit is contained in:
Larry Ruane 2020-03-17 15:35:39 -06:00 committed by Larry Ruane
parent 1dc439080b
commit 3ffef5c18e
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Makefile
View File

@ -18,11 +18,22 @@ GO_FILES := $(shell find . -name '*.go' | grep -v /vendor/ | grep -v '*_test.go'
GO_TEST_FILES := $(shell find . -name '*_test.go' -type f | rev | cut -d "/" -f2- | rev | sort -u) GO_TEST_FILES := $(shell find . -name '*_test.go' -type f | rev | cut -d "/" -f2- | rev | sort -u)
GO_BUILD_FILES := $(shell find . -name 'main.go') GO_BUILD_FILES := $(shell find . -name 'main.go')
# There are some files that are generated but are also in source control
# (so that the average clone - build doesn't need the required tools)
GENERATED_FILES := docs/rtd/index.html walletrpc/compact_formats.pb.go walletrpc/service.pb.go
PWD := $(shell pwd) PWD := $(shell pwd)
.PHONY: all dep build clean test coverage coverhtml lint doc simpledoc .PHONY: all dep build clean test coverage lint doc simpledoc
all: build all: first-make-timestamp build $(GENERATED_FILES)
# Ensure that the generated files that are also in git source control are
# initially more recent than the files they're generated from (so we don't try
# to rebuild them); this isn't perfect because it depends on doing a make before
# editing a .proto file; also, "make -jn" may trigger remake if n > 1.
first-make-timestamp:
touch $(GENERATED_FILES) $@
# Lint golang files # Lint golang files
lint: lint:
@ -63,6 +74,12 @@ doc: docs/rtd/index.html
docs/rtd/index.html: walletrpc/compact_formats.proto walletrpc/service.proto docs/rtd/index.html: walletrpc/compact_formats.proto walletrpc/service.proto
docker run --rm -v $(PWD)/docs/rtd:/out -v $(PWD)/walletrpc:/protos pseudomuto/protoc-gen-doc docker run --rm -v $(PWD)/docs/rtd:/out -v $(PWD)/walletrpc:/protos pseudomuto/protoc-gen-doc
walletrpc/compact_formats.pb.go: walletrpc/compact_formats.proto
cd walletrpc; protoc compact_formats.proto --go_out=plugins=grpc:.
walletrpc/service.pb.go: walletrpc/service.proto
cd walletrpc; protoc service.proto --go_out=plugins=grpc:.
# Generate documents using a very simple wrap-in-html approach (not ideal) # Generate documents using a very simple wrap-in-html approach (not ideal)
simpledoc: lwd-api.html simpledoc: lwd-api.html