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

fix: "edit add labels" make labels handle -f flag same as commonLabels #5809

Merged

Conversation

fktym
Copy link
Contributor

@fktym fktym commented Nov 25, 2024

kustomize edit add labels command modifies labels to handle the -f flag the same way as commonLabels. This change should also address one of the concerns raised in #4746 (comment).

Current Behavior:

  • commonLabels: kustomize edit add labels name:value -f overwrites existing labels when using -f flag
  • labels: kustomize edit add labels name:value -f --without-selector creates a new Labels entry even with -f flag

Fixed Behavior:

  • labels: kustomize edit add labels name:value -f --without-selector overwrites existing labels when using -f flag

Note:

  • When determining if labels are the same, we also check if the includeSelector and includeTemplates values match

This change unifies the -f flag behavior between commonLabels and labels. I needed this overwrite functionality as I use kustomize edit add labels in CI to update versions.

Related:
- #4746 (comment)
- #4486

Copy link

linux-foundation-easycla bot commented Nov 25, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 25, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @fktym!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. 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-sigs/kustomize 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 the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 25, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @fktym. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 25, 2024
@stormqueen1990
Copy link
Member

/test all

Copy link
Member

@stormqueen1990 stormqueen1990 left a comment

Choose a reason for hiding this comment

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

Hi there, @fktym! 👋🏻

Thank you for your contribution!

I just have a small suggestion on this for enhanced usability. Other than that, LGTM.


func (o *addMetadataOptions) writeToMapEntry(m map[string]string, k, v string, kind kindOfAdd) error {
if _, ok := m[k]; ok && !o.force {
return fmt.Errorf("%s %s already in kustomization file", kind, k)
Copy link
Member

Choose a reason for hiding this comment

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

Minor suggestion for usability:

Suggested change
return fmt.Errorf("%s %s already in kustomization file", kind, k)
return fmt.Errorf("%s %s already in kustomization file. Use --force to override.", kind, k)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stormqueen1990 Thanks for the feedback!
Totally agree that it'll help with usability. I've made the changes - mind taking another look?

@fktym fktym force-pushed the fix/add-label-without-selector branch from c17d9c6 to 8aa849c Compare December 4, 2024 02:43
@fktym fktym requested a review from stormqueen1990 December 10, 2024 00:56
Copy link
Member

@varshaprasad96 varshaprasad96 left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 11, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fktym, varshaprasad96

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

The pull request process is described 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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 11, 2024
@fktym fktym force-pushed the fix/add-label-without-selector branch from 8aa849c to 70e4d2e Compare December 12, 2024 05:03
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 12, 2024
@fktym
Copy link
Contributor Author

fktym commented Dec 12, 2024

@varshaprasad96
Thanks for the LGTM! Sorry, it seems I changed the error message but forgot to update the test accordingly. I've fixed it now, please review again

Copy link
Member

@stormqueen1990 stormqueen1990 left a comment

Choose a reason for hiding this comment

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

/lgtm
/ok-to-test

Thanks @fktym!

@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 Dec 13, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 13, 2024
@k8s-ci-robot k8s-ci-robot merged commit 86af799 into kubernetes-sigs:master Dec 13, 2024
4 checks passed
@fktym
Copy link
Contributor Author

fktym commented Dec 16, 2024

Thank you for the review. Looking forward to the release!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants