Generate flag types (again?) #1382
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
meatballhat
added
kind/discussion
plus minor touchups to genflags app
dearchap
approved these changes
May 7, 2022
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.
What type of PR is this?
What this PR does / why we need it:
As described in #1381, this work attempts to reintroduce flag type generation using a terse YAML input file and Go text templates for the purpose of reducing repetitive and error-prone work that results in inconsistent behavior across flag types.
Which issue(s) this PR fixes:
Closes #1381
Special notes for your reviewer:
One of the critical notes raised while discussing the history of why flag generation was last removed was that of clarity to contributors. For this reason, this PR includes updates to the
./docs/CONTRIBUTING.mddocument that describe why there is aMakefileat the top level, how it relates to type generation, and how to use it to ensure one's changes will integrate nicely.Testing
All existing flag-related tests pass, plus new generated tests.