diff --git a/buildtools/cli.go b/buildtools/cli.go index e3b9482eb..3a676691d 100644 --- a/buildtools/cli.go +++ b/buildtools/cli.go @@ -351,7 +351,7 @@ func GetCommands() []cli.Command { UsageText: helmcommand.GetArguments(), ArgsUsage: common.CreateEnvVars(), SkipFlagParsing: true, - Hidden: true, + Hidden: false, BashComplete: corecommon.CreateBashCompletionFunc(), Category: buildToolsCategory, Action: HelmCmd, diff --git a/docs/buildtools/helmcommand/help.go b/docs/buildtools/helmcommand/help.go index 99e3fa521..492af6988 100644 --- a/docs/buildtools/helmcommand/help.go +++ b/docs/buildtools/helmcommand/help.go @@ -3,11 +3,24 @@ package helmcommand var Usage = []string{"helm [command options]"} func GetDescription() string { - return "Run native Helm command" + return "Run native Helm command with build-info collection support." } func GetArguments() string { - return ` Examples: + return ` helm arguments + Helm command and arguments to execute. All standard Helm commands are supported. + + Command Options: + --build-name Build name. + --build-number Build number. + --module Optional module name for the build-info. + --project Project key for associating the build with a project. + --server-id Artifactory server ID configured using the config command. + --repository-cache Path to the Helm repository cache directory. + --username Artifactory username. + --password Artifactory password. + + Examples: $ jf helm push mychart-0.1.0.tgz oci://myrepo.jfrog.io/helm-local --build-name=my-build --build-number=1 @@ -15,21 +28,34 @@ func GetArguments() string { $ jf helm dependency update ./mychart --build-name=my-build --build-number=1 - Commands: - - install Install a chart. + $ jf helm package . --build-name=my-build --build-number=1 --server-id=my-server - upgrade Upgrade a release. + Supported Commands: package Package a chart directory into a chart archive. + Collects build-info including chart dependencies. + + push Push a chart to a remote registry (OCI). + Collects build-info for the pushed chart. - push Push a chart to remote. + dependency Manage a chart's dependencies. + The 'dependency update' command collects build-info for downloaded dependencies. + + pull Download a chart from a remote registry. + + install Install a chart. - pull Download a chart from remote. + upgrade Upgrade a release. repo Add, list, remove, update, and index chart repositories. - dependency Manage a chart's dependencies. + help, h Show help for any command. - help, h Show help for any command.` + Build Info Collection: + The helm command automatically collects build-info when used with --build-name and --build-number. + Build-info is collected for: + - Chart artifacts (when using 'push' commands) + - Chart dependencies (when using 'package' or 'dependency update' commands) + + Use 'jf rt build-publish' to publish the collected build-info to Artifactory.` }