feat(proto): Pull version of protoc-gen-doc allowing proto3 optional #91
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
This will make it easier to see what changed in the next commit (and any future changes we make here).
As we've decided to use the new proto3 optional semantics to handle nullable fields, we need to pass this flag until the feature is fully GA.
We'll need to temporarily use a fork of protoc-gen-doc so that we can include optional fields in proto3. As I don't want to actually make official releases of the fork, we'll want to build in the container from a specific tag/commit. This is what we used to do, before I changed it to pull the release (which is faster). This will be a bit slower the first time you run 'make proto' but should be temporary. Once the changes are in a released version upstream, we can go back to pulling an official release. If for some reason these changes don't end up upstream and it becomes an issue, I can make a release in my fork, but want to avoid that assuming this is temporary.
This commit pulls in a version of protoc-gen-doc that allows proto3 optional protos. I've created a tag on my fork v1.3.2-proto3optional.1 corresponding to the changes I've submitted upstream. (The idea being that any other changes would be come v1.3.2-proto3optional.2, and if I rebase off of v1.3.3 it would become v1.3.3-proto3optional.1 but hopefully this will get merged quickly upstream so we won't need to update this much).
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.
chore(proto): Bump protoc
style(proto): Break long lines in shell script
This will make it easier to see what changed in the next commit
(and any future changes we make here).
feat(proto): Add experimental flag
As we've decided to use the new proto3 optional semantics to handle nullable fields, we need to pass this flag until the feature is fully GA.
feat(proto): Compile protoc-gen-doc instead of using release
We'll need to temporarily use a fork of protoc-gen-doc so that we can include optional fields in proto3. As I don't want to actually make official releases of the fork, we'll want to build in the container from a specific tag/commit.
This is what we used to do, before I changed it to pull the release
(which is faster). This will be a bit slower the first time you run 'make proto' but should be temporary. Once the changes are in a released version upstream, we can go back to pulling an official release.
If for some reason these changes don't end up upstream and it becomes an issue, I can make a release in my fork, but want to avoid that assuming this is temporary.
feat(proto): Pull version of protoc-gen-doc allowing proto3 optional
This commit pulls in a version of protoc-gen-doc that allows proto3 optional protos. I've created a tag on my fork v1.3.2-proto3optional.1 corresponding to the changes I've submitted upstream. (The idea being that any other changes would be come v1.3.2-proto3optional.2, and if I rebase off of v1.3.3 it would become v1.3.3-proto3optional.1 but hopefully this will get merged quickly upstream so we won't need to update this much).