Skip to content

Commit e4c54ec

Browse files
authored
Remove duplicate task for protobuf docs generation (#1387)
The "gRPC reference" section of the documentation website is automatically generated from the repository's protocol buffer files. In order to make this generation process easy for developers to run, the necessary commands are defined in a task. For some reason, there were two tasks for this purpose, with different names and descriptions, but identical commands. This makes the taskfile more difficult to understand and more difficult to maintain. One of the tasks, `protoc:docs` is called by the `docs:generate` task. The other, `docs:gen:protobuf`, is not used or referenced anywhere in the repository. So I have removed `docs:gen:protobuf` from the taskfile.
1 parent 3e41455 commit e4c54ec

File tree

1 file changed

+0
-8
lines changed

1 file changed

+0
-8
lines changed

Taskfile.yml

-8
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ includes:
44
dist: ./DistTasks.yml
55

66
tasks:
7-
docs:gen:protobuf:
8-
desc: Generate markdown contents for protobuffers
9-
cmds:
10-
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
11-
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,monitor.md --proto_path=rpc ./rpc/cc/arduino/cli/monitor/v1/*.proto'
12-
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,settings.md --proto_path=rpc ./rpc/cc/arduino/cli/settings/v1/*.proto'
13-
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,debug.md --proto_path=rpc ./rpc/cc/arduino/cli/debug/v1/*.proto'
14-
157
docs:generate:
168
desc: Create all generated documentation content
179
deps:

0 commit comments

Comments
 (0)