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

Do not raise an error proposing to use '--overwrite' when labeling with the same value #105936

Merged
merged 2 commits into from May 4, 2022
Merged

Do not raise an error proposing to use '--overwrite' when labeling with the same value #105936

merged 2 commits into from May 4, 2022

Conversation

zigarn
Copy link
Contributor

@zigarn zigarn commented Oct 27, 2021

What type of PR is this?

/kind bug

What this PR does / why we need it:

Currently, when trying to set a label with the same value as current one, kubectl advise to use the --overwrite option:

$ kubectl create namespace test
namespace/test created
$ kubectl label namespace test usage=test
namespace/test labeled
$ kubectl label namespace test usage=test
error: 'usage' already has a value (test), and --overwrite is false

But then, overwriting for the same value is a bit weird.

This PR propose to detect this situation and do nothing:

$ kubectl label namespace test usage=test
namespace/test not labeled

Which issue(s) this PR fixes:

No existing issue.

Special notes for your reviewer:

Maybe, it could give a better output like "xxx label unchanged".
But it would require quite more modifications.

Does this PR introduce a user-facing change?

Do not raise an error when setting a label with the same value, just ignore it.

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

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 27, 2021
@k8s-ci-robot
Copy link
Contributor

@zigarn: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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 k8s-ci-robot added do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 27, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @zigarn!

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
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 27, 2021
@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 27, 2021
@lauchokyip
Copy link
Member

For reviewer:

Looks like not labeled just means the oldObj has not been changed compare to the newObj using the message not labeled might be acceptable

https://github.com/kubernetes/kubectl/blob/7bae6d690aaca2598a22e197d67cb3ba9b52cc1b/pkg/cmd/label/label.go#L392

@lauchokyip
Copy link
Member

/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 Oct 27, 2021
@lauchokyip
Copy link
Member

@zigarn Can you add some unit test cases for the change? Thank You

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 28, 2021
@zigarn
Copy link
Contributor Author

zigarn commented Oct 28, 2021

@lauchokyip Tests fixed (I was wrong on my local test launch)

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 2, 2021
@zigarn zigarn changed the title Do not propose to use '--overwrite' when labeling with the same value Do not raise an error proposing to use '--overwrite' when labeling with the same value Nov 2, 2021
@pacoxu pacoxu added this to Needs review in SIG CLI Nov 8, 2021
@eddiezane
Copy link
Member

Thanks for the PR! This LGTM but I don't have the history behind this behavior. I'll check with some folks Wednesday and circle back.

eddiezane
eddiezane approved these changes Jan 12, 2022
View reviewed changes
Copy link
Member

@eddiezane eddiezane left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

/lgtm
/approve
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jan 12, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: eddiezane, zigarn

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 Jan 12, 2022
@k8s-triage-robot
Copy link

The Kubernetes project has merge-blocking tests that are currently too flaky to consistently pass.

This bot retests PRs for certain kubernetes repos according to the following rules:

  • The PR does have any do-not-merge/* labels
  • The PR does not have the needs-ok-to-test label
  • The PR is mergeable (does not have a needs-rebase label)
  • The PR is approved (has cncf-cla: yes, lgtm, approved labels)
  • The PR is failing tests required for merge

You can:

/retest

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 12, 2022
@zigarn
Copy link
Contributor Author

zigarn commented Jan 12, 2022 •
edited

/retest

@eddiezane: I rebased to fix the new test TestLabelMsg created by #104372 and merged in master since this PR was created.

@astraw99 astraw99 mentioned this pull request Jan 20, 2022
Merged
@zigarn
Copy link
Contributor Author

zigarn commented Mar 24, 2022

/retest

@eddiezane
Copy link
Member

/lgtm

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

zigarn commented Mar 29, 2022

/retest

1 similar comment
@eddiezane
Copy link
Member

/retest

@k8s-triage-robot
Copy link

The Kubernetes project has merge-blocking tests that are currently too flaky to consistently pass.

This bot retests PRs for certain kubernetes repos according to the following rules:

  • The PR does have any do-not-merge/* labels
  • The PR does not have the needs-ok-to-test label
  • The PR is mergeable (does not have a needs-rebase label)
  • The PR is approved (has cncf-cla: yes, lgtm, approved labels)
  • The PR is failing tests required for merge

You can:

/retest

@zigarn zigarn mentioned this pull request Apr 15, 2022
Merged
@k8s-ci-robot k8s-ci-robot merged commit 10eb709 into kubernetes:master May 4, 2022
SIG CLI automation moved this from Needs review to Done May 4, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.25 milestone May 4, 2022
@zigarn zigarn deleted the no-error-relabel branch May 4, 2022 04:16
muyangren2 pushed a commit to muyangren2/kubernetes that referenced this pull request Jul 14, 2022
@zigarn @muyangren2
Do not raise an error proposing to use '--overwrite' when labeling wi…
94e4bfe 
…th the same value (kubernetes#105936)

* Do not propose to use '--overwrite' when labeling with the same value

* Check expected error value in label_test.TestLabelFunc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pwittrock pwittrock Awaiting requested review from pwittrock

@eddiezane eddiezane Awaiting requested review from eddiezane

@lauchokyip lauchokyip Awaiting requested review from lauchokyip

Assignees

@eddiezane eddiezane

@seans3 seans3

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/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 Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
SIG CLI
Done
Milestone
v1.25
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@zigarn @k8s-ci-robot @lauchokyip @dims @eddiezane @k8s-triage-robot @seans3