Skip to content

Commit

Permalink
Fix proto to markdown generation. (#2169)
Browse files Browse the repository at this point in the history
* [376]: Update our protodoc markdown tempalate to better match the default one, but fix the description cell content.

* [376]: Create the proto-doc-gen.sh script that will recreate docs/proto-docs.md and create a proto-doc-gen make target. Add proto-doc-gen to proto-all and proto-regen.

* [376]: make proto-doc-gen

* [376]: Add a note about why we're not using the docker image for this so that we don't all have to install protoc and protoc-gen-doc.

* [376]: Add changelog entry.
  • Loading branch information
SpicyLemon authored Oct 7, 2024
1 parent 65a719d commit c4ce165
Show file tree
Hide file tree
Showing 5 changed files with 5,806 additions and 4,911 deletions.
1 change: 1 addition & 0 deletions .changelog/unreleased/bug-fixes/376-fix-markdown-gen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Fix proto markdown generation and regenerate proto-docs.md [#376](https://github.com/provenance-io/provenance/issues/376).
10 changes: 7 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -474,9 +474,9 @@ indexer-db-down:
##############################
# Proto -> golang compilation
##############################
proto-all: proto-update-deps proto-format proto-lint proto-check-breaking proto-check-breaking-third-party proto-gen proto-swagger-gen
proto-all: proto-update-deps proto-format proto-lint proto-check-breaking proto-check-breaking-third-party proto-gen proto-swagger-gen proto-doc-gen
proto-checks: proto-update-deps proto-lint proto-check-breaking proto-check-breaking-third-party
proto-regen: proto-format proto-gen proto-swagger-gen
proto-regen: proto-format proto-gen proto-swagger-gen proto-doc-gen

containerProtoVer=0.14.0
containerProtoImage=ghcr.io/cosmos/proto-builder:$(containerProtoVer)
Expand Down Expand Up @@ -509,6 +509,10 @@ proto-swagger-gen:
fi
$(GO) mod tidy

proto-doc-gen:
@echo "Generating Protobuf Markdown"
./scripts/proto-doc-gen.sh

proto-format:
@echo "Formatting Protobuf files"
if docker ps -a --format '{{.Names}}' | grep -Eq "^${containerProtoFmt}$$"; then \
Expand Down Expand Up @@ -543,7 +547,7 @@ proto-update-deps:
@echo "Updating Protobuf files"
sh ./scripts/proto-update-deps.sh

.PHONY: proto-all proto-checks proto-regen proto-gen proto-format proto-lint proto-check-breaking proto-check-breaking-third-party proto-update-deps proto-update-check
.PHONY: proto-all proto-checks proto-regen proto-gen proto-format proto-lint proto-check-breaking proto-check-breaking-third-party proto-update-deps proto-update-check proto-doc-gen


##############################
Expand Down
Loading

0 comments on commit c4ce165

Please sign in to comment.