Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate flag types (again?) #1382

Merged
merged 5 commits into from May 7, 2022
Merged

Generate flag types (again?) #1382

merged 5 commits into from May 7, 2022

Conversation

meatballhat
Copy link
Member

@meatballhat meatballhat commented May 2, 2022

What type of PR is this?

  • cleanup

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.md document that describe why there is a Makefile at 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.

@meatballhat meatballhat added kind/discussion is for discussion area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince labels May 2, 2022
@meatballhat meatballhat added this to the Release 2.x milestone May 2, 2022
@meatballhat meatballhat requested a review from a team as a code owner May 2, 2022
@meatballhat meatballhat merged commit 48f612c into main May 7, 2022
12 checks passed
@meatballhat meatballhat deleted the generating-flags-again branch May 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince kind/discussion is for discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(re)introduce flag type generation
2 participants