chore(proto): reserved only for what would be breaking change #1684
+18
−13
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
github-actions
bot
added
proto
joroshiba
requested review from
SuperFluffy,
WafflesVonMaple and
ethanoroshiba
SuperFluffy
reviewed
Oct 18, 2024
| reserved 3 to 10; | ||
| reserved 15 to 20; | ||
| reserved 23 to 30; | ||
| reserved 57 to 60; | ||
|
|
||
| // deprecated fields | ||
| reserved 54; // deprecated "mint_action" |
There was a problem hiding this comment.
Since we are effectively releasing new protobufs, are we justified in removing these fields as well?
| reserved 3 to 10; | ||
| reserved 15 to 20; | ||
| reserved 23 to 30; | ||
| reserved 57 to 60; | ||
|
|
||
| // deprecated fields | ||
| reserved 54; // deprecated "mint_action" |
There was a problem hiding this comment.
This one on the other hand I am fine with retaining, since this actually is the old v1alpha1 type.
ethanoroshiba
approved these changes
Oct 18, 2024
There was a problem hiding this comment.
LGTM. Looks like the way the lint workflow is setup, the individual check may still fail but allow the overall status checks to pass, which I hope should be a good flag for anyone reviewing breaking proto changes in the future. Still, I think we may want to flag this to the broader engineering group as a "this label should probably almost never be used" thing.
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.
Summary
We have been using reserved to highlight gaps, but reserved should ideally only be utilized for reserving previously used identifiers.
Changes
Breaking Changes
This has no real breaking changes, hence allowing override. The removal of the reserved makes it so that we don't have to do this in the future when adding new fields.