Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Use buf.build to manage our protobuf related activities #2736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Prev Previous commit
Next Next commit
Taskfile: use buf to generate docs
  • Loading branch information
alessio-perugini authored and cmaglie committed Oct 21, 2024
commit 257bc0dc377495a8f264b150d15b6ebde76bb708
3 changes: 2 additions & 1 deletion 3 Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,8 @@ tasks:
protoc:docs:
desc: Generate docs for protobuf definitions
cmds:
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
- |
buf generate --template buf.doc.gen.yaml

docs:include-configuration-json-schema:
desc: Copy configuration JSON schema to make it available in documentation
Expand Down
10 changes: 10 additions & 0 deletions 10 buf.doc.gen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: v2
plugins:
# Local plugin used to generate docs
# go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@v1.4.1
- local: protoc-gen-doc
out: ./docs/rpc
opt:
- markdown,commands.md
inputs:
- directory: ./rpc
Morty Proxy This is a proxified and sanitized view of the page, visit original site.