Skip to content

fix(cmd): correct the short description of kk create config - #3201

Merged
kubesphere-prow[bot] merged 1 commit into
kubesphere:mainfrom
redscholar:fix/kk-create-config-short-desc
Aug 20, 2026
Merged

fix(cmd): correct the short description of kk create config#3201
kubesphere-prow[bot] merged 1 commit into
kubesphere:mainfrom
redscholar:fix/kk-create-config-short-desc

Conversation

@redscholar

Copy link
Copy Markdown
Contributor

/kind bug

What does this PR do

Fix the incorrect Short help description of the kk create config command.

Background / Motivation

kk create config only generates a default cluster configuration file
(config-<version>.yaml) or prints it to stdout. However, its Short help
text was copied from create cluster and wrongly read "Create a Kubernetes or
KubeSphere cluster", which misleads users into thinking the command creates a
cluster.

Implementation

Correct the Short string of the config subcommand to describe what it
actually does.

Key Changes

File What changed
cmd/kk/app/builtin/create.go Fix the Short description of the create config command

Impact

  • Affected modules: kubekey CLI (builtin commands)
  • API changes: N/A
  • Database / state changes: N/A
  • Config changes: N/A
  • Dependency changes: N/A

Breaking Changes

None

Which issue(s) this PR fixes:

Fixes #

Testing

Verification performed

  • Unit tests pass (make test)
  • Integration / E2E tests pass
  • Manual verification

Steps to verify

  1. Build the CLI: go build -tags builtin ./cmd/kk/app/builtin/
  2. Run kk create config --help
  3. Expected: description reads "Create a cluster configuration file"

Test coverage

No tests added. This is a help-text fix with no functional change; the
builtin package compiles cleanly under -tags builtin.

Rollback

Plain revert of the single-line change.

Does this PR introduce a user-facing change?

Correct the help description of the `kk create config` command.

Checklist

  • Code self-reviewed, no debug code or commented-out dead code
  • No secrets, tokens, or .env files committed
  • Commit message follows Conventional Commits
  • All commits have DCO sign-off (Signed-off-by)
  • All commits are GPG-signed (GitHub shows Verified)
  • Tests added or updated
  • Docs / CHANGELOG updated (if needed)
  • Local lint and build pass (make build)
  • Breaking changes marked above

Notes for Reviewer

Single-line help text correction; the previous text was a copy-paste from
create cluster.

The create config command only generates a default cluster
configuration file (config-<version>.yaml or prints to stdout), but its
Short help text was copied from create cluster, wrongly reading
"Create a Kubernetes or KubeSphere cluster". Align it with what the
command actually does.

Signed-off-by: redscholar <blacktiledhouse@gmail.com>
@kubesphere-prow kubesphere-prow Bot added release-note kind/bug Categorizes issue or PR as related to a bug. labels Aug 20, 2026
@kubesphere-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: redscholar

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:

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

@kubesphere-prow kubesphere-prow Bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 20, 2026
@sonarqubecloud

Copy link
Copy Markdown

@redscholar redscholar added the lgtm Indicates that a PR is ready to be merged. label Aug 20, 2026
@kubesphere-prow
kubesphere-prow Bot merged commit 283b126 into kubesphere:main Aug 20, 2026
7 checks passed
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. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant