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.

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

Add deprecation warning message to commonLabels #5464

Merged
merged 3 commits into from Nov 30, 2023
Merged

Add deprecation warning message to commonLabels #5464

merged 3 commits into from Nov 30, 2023

Conversation

ncapps
Copy link
Contributor

@ncapps ncapps commented Nov 25, 2023

commonLabels and labels with includeSelectors enabled produce the same output. It would beneficial to remove duplicate behavior where possible. The commonLabels field can be deprecated in kustomization v1.

This change adds a deprecation warning message to the commonLabels field.

Related issue: #5436

Sample output:

~/go/bin/kustomize build
# Warning: 'commonLabels' is deprecated. Please use 'labels' instead.

@k8s-ci-robot
Copy link
Contributor

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@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 Nov 25, 2023
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 25, 2023
@ncapps ncapps changed the title Add deprecation warning message for commonLabels Add deprecation warning message to commonLabels Nov 25, 2023
@ncapps
Copy link
Contributor Author

ncapps commented Nov 25, 2023

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Nov 25, 2023
@ncapps ncapps marked this pull request as ready for review November 25, 2023 02:01
@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 Nov 25, 2023
charles-chenzz
charles-chenzz reviewed Nov 27, 2023
View reviewed changes
Copy link
Member

@charles-chenzz charles-chenzz left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2023
kundan2707
kundan2707 reviewed Nov 27, 2023
View reviewed changes
Copy link
Contributor

@kundan2707 kundan2707 left a comment

Choose a reason for hiding this comment

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

/lgtm

stormqueen1990
stormqueen1990 reviewed Nov 28, 2023
View reviewed changes
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, @ncapps! 👋
Change LGTM, just have one outstanding question.

/lgtm

api/types/kustomization.go Outdated
@@ -188,6 +188,7 @@ const (
deprecatedPatchesJson6902Message = "# Warning: 'patchesJson6902' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix
deprecatedPatchesStrategicMergeMessage = "# Warning: 'patchesStrategicMerge' is deprecated. Please use 'patches' instead." + " " + deprecatedWarningToRunEditFix
deprecatedVarsMessage = "# Warning: 'vars' is deprecated. Please use 'replacements' instead." + " " + deprecatedWarningToRunEditFixExperimential
deprecatedCommonLabelsWarningMessage = "# Warning: 'commonLabels' is deprecated. Please use 'labels' instead."
Copy link
Member

Choose a reason for hiding this comment

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

question: is this something that kustomize edit fix also fixes automatically? If yes, should we append the message from line 184 here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great catch! I didn't know about this feature. I tested kustomize edit fix and verified that fix does replace commonLabels with labels. Here is relevant fix code.

Per your suggestion , I appended the deprecatedWarningToRunEditFix message.

Copy link
Member

Choose a reason for hiding this comment

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

Amazing, thanks for updating it!

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023
stormqueen1990
stormqueen1990 reviewed Nov 29, 2023
View reviewed changes
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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2023
@natasha41575
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: natasha41575, ncapps

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 Nov 30, 2023
@k8s-ci-robot k8s-ci-robot merged commit f23d45f into kubernetes-sigs:master Nov 30, 2023
9 checks passed
@ncapps ncapps mentioned this pull request Dec 1, 2023
Merged
@dmavis dmavis mentioned this pull request Jan 13, 2024
Open
@ncapps ncapps deleted the deprecate/commonLabels branch January 31, 2024 01:29
@ptr1120 ptr1120 mentioned this pull request Feb 28, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stormqueen1990 stormqueen1990 stormqueen1990 left review comments

@kundan2707 kundan2707 kundan2707 left review comments

@charles-chenzz charles-chenzz charles-chenzz left review comments

@annasong20 annasong20 Awaiting requested review from annasong20

@natasha41575 natasha41575 Awaiting requested review from natasha41575

Assignees

@natasha41575 natasha41575

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. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
Kustomize Core Usability Bugs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@ncapps @k8s-ci-robot @natasha41575 @stormqueen1990 @kundan2707 @charles-chenzz