Skip to content

cleanup: Migrate deprecated function ExtractCommentTags #131711

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

cleanup: Migrate deprecated function ExtractCommentTags #131711

wants to merge 1 commit into from

Conversation

gavinkflam
Copy link
Contributor

@gavinkflam gavinkflam commented May 11, 2025 •
edited
Loading

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

ExtractCommentTags is deprecated, and we need to migrate the usages to ExtractFunctionStyleCommentTags.

This PR addresses some low-hanging fruits and introduces a utility function to facilitate further migration of the remaining usages.

Which issue(s) this PR fixes:

Part of #130358

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 11, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gavinkflam
Once this PR has been reviewed and has the lgtm label, please assign wojtek-t for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 11, 2025
@k8s-ci-robot k8s-ci-robot requested a review from caesarxuchao May 11, 2025 03:18
@k8s-ci-robot k8s-ci-robot requested a review from deads2k May 11, 2025 03:18
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 11, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @gavinkflam!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 11, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @gavinkflam. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@gavinkflam gavinkflam mentioned this pull request May 11, 2025
Open
@gavinkflam gavinkflam force-pushed the 130358-migrate-extract-comment-tags branch 2 times, most recently from 259a811 to 2e1490d Compare May 11, 2025 14:35
@gavinkflam gavinkflam marked this pull request as draft May 11, 2025 14:55
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 11, 2025
@gavinkflam gavinkflam force-pushed the 130358-migrate-extract-comment-tags branch from 2e1490d to ed73a19 Compare May 11, 2025 15:47
Octopusjust
Octopusjust reviewed May 12, 2025
View reviewed changes
Copy link
Contributor

@Octopusjust Octopusjust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 12, 2025
@gavinkflam gavinkflam marked this pull request as ready for review May 12, 2025 01:50
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 12, 2025
@gavinkflam
Copy link
Contributor Author

Pipeline is all green. PTAL

@jpbetz
Copy link
Contributor

jpbetz commented May 13, 2025

/assign @yongruilin

@jpbetz
Copy link
Contributor

jpbetz commented May 15, 2025

/triage accepted

@k8s-ci-robot k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label May 15, 2025
@k8s-ci-robot k8s-ci-robot removed the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 15, 2025
@gavinkflam
Copy link
Contributor Author

@yongruilin Just checking in - did you have a chance to take a look?

yongruilin
yongruilin reviewed Jun 5, 2025
View reviewed changes
Copy link
Contributor

@yongruilin yongruilin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/hold
Please wait for #132110 merge and rebase on it.

staging/src/k8s.io/code-generator/pkg/util/comments.go
// Then this function will return:
//
// map[string][]string{"foo":{"val1", "val2", "val3"}, "bar": {""}, "baz": {`"qux"`}}
func ExtractCommentTagsWithoutArguments(marker string, tagNames []string, lines []string) (map[string][]string, error) {
Copy link
Contributor

@yongruilin yongruilin Jun 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you help me to understand why this is needed for the above generators?
If it is common enough, I suggest to put it inside gengo/v2, then import it to use.

Copy link
Contributor Author

@gavinkflam gavinkflam Jun 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing generator tags are not function-style, so the behavior of function-style usages is undefined. I propose we simply ignore tags that include arguments, but I’m happy to adjust the implementation if we decide to handle them differently.

This helper function helps reduce boilerplate by filtering and collecting parsed tags. It’s probably too specific for gengo/v2, but I’d be glad to submit it there if you think it might be useful.

Example Usage Proposed Effect
+k8s:deepcopy-gen:nonpointer-interfaces=true Accepted
+k8s:deepcopy-gen:nonpointer-interfaces()=true Accepted
+k8s:deepcopy-gen:nonpointer-interfaces(a=1)=true Ignored

What are your thoughts?

cc @jpbetz

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's be strict and have the code generator fail with an error if an unexpected argument ((a=1) case) is present.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I can tweak that.

Copy link
Contributor Author

@gavinkflam gavinkflam Jun 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and rebased. New behavior:

Example Usage Proposed Effect
+k8s:deepcopy-gen:nonpointer-interfaces=true Accepted
+k8s:deepcopy-gen:nonpointer-interfaces()=true Accepted
+k8s:deepcopy-gen:nonpointer-interfaces(a=1)=true Error

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 5, 2025
@gavinkflam gavinkflam force-pushed the 130358-migrate-extract-comment-tags branch from ed73a19 to 87bad77 Compare June 6, 2025 21:34
@gavinkflam gavinkflam force-pushed the 130358-migrate-extract-comment-tags branch from 87bad77 to f4ab6c2 Compare June 6, 2025 21:59
@gavinkflam gavinkflam requested a review from yongruilin June 6, 2025 23:03
@gavinkflam
Copy link
Contributor Author

@yongruilin #132110 is merged yesterday. I've rebased and the pipeline is green. Please take another look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpbetz jpbetz jpbetz left review comments

@Octopusjust Octopusjust Octopusjust left review comments

@caesarxuchao caesarxuchao Awaiting requested review from caesarxuchao

@deads2k deads2k Awaiting requested review from deads2k

@yongruilin yongruilin Awaiting requested review from yongruilin

Assignees

@yongruilin yongruilin

Labels
area/code-generation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gavinkflam @k8s-ci-robot @jpbetz @yongruilin @Octopusjust