Remove duplicate task for protobuf docs generation #1387
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
type: enhancement
silvanocerza
approved these changes
Aug 11, 2021
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)Infrastructure clean up
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:docsis called by thedocs:generatetask. The other,docs:gen:protobuf, is not used orreferenced anywhere in the repository. So I have removed
docs:gen:protobuffrom the taskfile.titled accordingly?
The removal of the
docs:gen:protobuftask will disrupt the workflow of any developer who is accustomed to having it available.This could be avoided by deprecating the task rather than doing an immediate removal. However, this removal unlikely to have a significant impact.
However, there is no change to the application's API.