fix: command in karmadactl create should be karmadactl instead of kubectl by FAUST-BENCHOU · Pull Request #7545 · karmada-io/karmada

FAUST-BENCHOU · 2026-05-23T09:47:03Z

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #7542

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR adds richer create subcommand help output by introducing per-subcommand Example strings and wiring a recursive helper to apply them across the cobra command tree.

Changes:

Added example text blocks for many create subcommands (namespace, quota, configmap, RBAC, ingress, secrets, services, etc.).
Introduced a createSubcommandExamples lookup map keyed by subcommand name.
Added setCreateSubcommandExamples to recursively set subCmd.Example during NewCmdCreate.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

gemini-code-assist

Code Review

This pull request introduces a comprehensive set of example strings for various karmadactl create subcommands and implements a recursive function, setCreateSubcommandExamples, to apply these examples to the command hierarchy. Feedback was provided regarding a formatting bug in the podDisruptionBudgetExample where a percentage sign needs to be escaped to prevent fmt.Sprintf errors. Additionally, it was recommended to add a documentation comment to the new setCreateSubcommandExamples function to align with maintainability best practices.

codecov-commenter · 2026-05-23T10:13:59Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.06%. Comparing base (7bdab44) to head (1e78543).

Files with missing lines	Patch %	Lines
pkg/karmadactl/create/create.go	0.00%	6 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7545      +/-   ##
==========================================
- Coverage   42.07%   42.06%   -0.01%     
==========================================
  Files         879      879              
  Lines       54821    54827       +6     
==========================================
- Hits        23064    23063       -1     
- Misses      30013    30020       +7     
  Partials     1744     1744

Flag	Coverage Δ
unittests	`42.06% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

XiShanYongYe-Chang · 2026-05-25T07:17:27Z

cc @zhzhuang-zju

RainbowMango · 2026-06-17T01:33:37Z

Just out of curiosity, the generated command-line-flags should be updated after this PR, but why not?

FAUST-BENCHOU · 2026-06-17T02:15:24Z

Just out of curiosity, the generated command-line-flags should be updated after this PR, but why not?

because at that time, karmadactl doc 's PR had not yet been merged lol.Let me rebase to the newest

RainbowMango · 2026-06-17T02:16:48Z

OK. thanks.

FAUST-BENCHOU · 2026-06-17T02:52:10Z

/cc @RainbowMango I simplified it to a recursive method.

RainbowMango · 2026-06-17T03:23:26Z

+func replaceCreateSubcommandExamples(cmd *cobra.Command, parentCommand string) {
+	for _, subCmd := range cmd.Commands() {
+		if subCmd.Example != "" {
+			subCmd.Example = strings.ReplaceAll(subCmd.Example, "kubectl", parentCommand)


Another replace approach is to strictly match kubectl create, so it won't accidentally replace anything should't be replaced, like:

Suggested change

subCmd.Example = strings.ReplaceAll(subCmd.Example, "kubectl", parentCommand)

subCmd.Example = strings.ReplaceAll(subCmd.Example, "kubectl create", parentCommand+" create")

But, no big deal, it's up to you.

/approve
/lgtm

/hold
for @FAUST-BENCHOU confirm

…ectl Signed-off-by: zhoujinyu <2319109590@qq.com>

RainbowMango

/lgtm
/approve

/hold cancel
Thanks.

karmada-bot · 2026-06-17T03:28:54Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [RainbowMango]

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

Copilot AI review requested due to automatic review settings May 23, 2026 09:47

karmada-bot requested review from chaosi-zju and yanfeng1992 May 23, 2026 09:47

karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 23, 2026

Copilot AI reviewed May 23, 2026

View reviewed changes

Comment thread pkg/karmadactl/create/create.go Outdated

Comment thread pkg/karmadactl/create/create.go Outdated

Comment thread pkg/karmadactl/create/create.go Outdated

Comment thread pkg/karmadactl/create/create.go Outdated

gemini-code-assist Bot reviewed May 23, 2026

View reviewed changes

Comment thread pkg/karmadactl/create/create.go Outdated

Comment thread pkg/karmadactl/create/create.go Outdated

FAUST-BENCHOU force-pushed the fix/kubectl-example branch from 53acb8d to 57604bd Compare May 23, 2026 09:55

XiShanYongYe-Chang mentioned this pull request May 25, 2026

Example command in website of karmadactl create is kubectl instead of karmadactl #7542

Closed

RainbowMango added this to the v1.19 milestone Jun 17, 2026

FAUST-BENCHOU force-pushed the fix/kubectl-example branch 2 times, most recently from b0f4fc0 to 9674d1c Compare June 17, 2026 02:43

RainbowMango reviewed Jun 17, 2026

View reviewed changes

karmada-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 17, 2026

karmada-bot assigned RainbowMango Jun 17, 2026

karmada-bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 17, 2026

fix: command in karmadactl create should be karmadactl instead of kub…

1e78543

…ectl Signed-off-by: zhoujinyu <2319109590@qq.com>

FAUST-BENCHOU force-pushed the fix/kubectl-example branch from 9674d1c to 1e78543 Compare June 17, 2026 03:27

karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 17, 2026

RainbowMango approved these changes Jun 17, 2026

View reviewed changes

karmada-bot added lgtm Indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 17, 2026

karmada-bot merged commit 0227123 into karmada-io:master Jun 17, 2026
18 checks passed

	subCmd.Example = strings.ReplaceAll(subCmd.Example, "kubectl", parentCommand)
	subCmd.Example = strings.ReplaceAll(subCmd.Example, "kubectl create", parentCommand+" create")

Uh oh!

Conversation

FAUST-BENCHOU commented May 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

XiShanYongYe-Chang commented May 25, 2026

Uh oh!

RainbowMango commented Jun 17, 2026

Uh oh!

FAUST-BENCHOU commented Jun 17, 2026

Uh oh!

RainbowMango commented Jun 17, 2026

Uh oh!

FAUST-BENCHOU commented Jun 17, 2026

Uh oh!

RainbowMango Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

FAUST-BENCHOU Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

RainbowMango left a comment

Choose a reason for hiding this comment

Uh oh!

karmada-bot commented Jun 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-commenter commented May 23, 2026 •

edited

Loading