search

kubernetes-sigs / kustomize

Customization of kubernetes YAML configurations
Apache License 2.0
10.7k stars 2.22k forks source link

chore: add deprecation comment to commonLabels #5699

Closed stormqueen1990 closed 1 month ago

stormqueen1990 commented 1 month ago

commonLabels is deprecated, but the field did not have a deprecation comment, like other fields do. Add the deprecation comment, as some IDEs use that as a guideline to show a strikethrough in the field names (and to follow the pattern of other deprecated fields).

/kind documentation

koba1t commented 1 month ago

I think the commonLabels is already deprecated with the PR below. https://github.com/kubernetes-sigs/kustomize/pull/5464

Thanks @stormqueen1990 /lgtm /approve

k8s-ci-robot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: koba1t, stormqueen1990

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: - ~~[OWNERS](https://github.com/kubernetes-sigs/kustomize/blob/master/OWNERS)~~ [koba1t] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
koba1t commented 1 month ago

Hi @stormqueen1990 Could you add a deprecated message for web docs? https://github.com/kubernetes-sigs/cli-experimental/blob/master/site/content/en/references/kustomize/kustomization/commonlabels/_index.md

stormqueen1990 commented 1 month ago

Hi @stormqueen1990 Could you add a deprecated message for web docs? https://github.com/kubernetes-sigs/cli-experimental/blob/master/site/content/en/references/kustomize/kustomization/commonlabels/_index.md

Hi there, @koba1t! Sure thing!