From 577880f0191bbe3fc23dbdb93a08962fc652e2ed Mon Sep 17 00:00:00 2001 From: Rizul Gupta Date: Sat, 13 Jan 2024 23:38:11 +0530 Subject: [PATCH] change help text of --publish Signed-off-by: Rizul Gupta --- internal/commands/build.go | 2 +- internal/commands/builder_create.go | 2 +- internal/commands/buildpack_package.go | 2 +- internal/commands/create_builder.go | 2 +- internal/commands/extension_package.go | 2 +- internal/commands/package_buildpack.go | 2 +- internal/commands/rebase.go | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/internal/commands/build.go b/internal/commands/build.go index 3984da850..2ed6bd27b 100644 --- a/internal/commands/build.go +++ b/internal/commands/build.go @@ -241,7 +241,7 @@ func buildCommandFlags(cmd *cobra.Command, buildFlags *BuildFlags, cfg config.Co cmd.Flags().StringVar(&buildFlags.Network, "network", "", "Connect detect and build containers to network") cmd.Flags().StringArrayVar(&buildFlags.PreBuildpacks, "pre-buildpack", []string{}, "Buildpacks to prepend to the groups in the builder's order") cmd.Flags().StringArrayVar(&buildFlags.PostBuildpacks, "post-buildpack", []string{}, "Buildpacks to append to the groups in the builder's order") - cmd.Flags().BoolVar(&buildFlags.Publish, "publish", false, "Publish to registry") + cmd.Flags().BoolVar(&buildFlags.Publish, "publish", false, "This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others.") cmd.Flags().StringVar(&buildFlags.DockerHost, "docker-host", "", `Address to docker daemon that will be exposed to the build container. If not set (or set to empty string) the standard socket location will be used. diff --git a/internal/commands/builder_create.go b/internal/commands/builder_create.go index 89e915acc..81e059ab1 100644 --- a/internal/commands/builder_create.go +++ b/internal/commands/builder_create.go @@ -107,7 +107,7 @@ Creating a custom builder allows you to control what buildpacks are used and wha cmd.Flags().MarkHidden("buildpack-registry") } cmd.Flags().StringVarP(&flags.BuilderTomlPath, "config", "c", "", "Path to builder TOML file (required)") - cmd.Flags().BoolVar(&flags.Publish, "publish", false, "Publish to registry") + cmd.Flags().BoolVar(&flags.Publish, "publish", false, "This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others.") cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") cmd.Flags().BoolVar(&flags.Flatten, "flatten", false, "Flatten each composite buildpack into a single layer") cmd.Flags().StringSliceVarP(&flags.FlattenExclude, "flatten-exclude", "e", nil, "Buildpacks to exclude from flattening, in the form of '@'") diff --git a/internal/commands/buildpack_package.go b/internal/commands/buildpack_package.go index b4c49893a..d69a9d6e4 100644 --- a/internal/commands/buildpack_package.go +++ b/internal/commands/buildpack_package.go @@ -131,7 +131,7 @@ func BuildpackPackage(logger logging.Logger, cfg config.Config, packager Buildpa cmd.Flags().StringVarP(&flags.PackageTomlPath, "config", "c", "", "Path to package TOML config") cmd.Flags().StringVarP(&flags.Format, "format", "f", "", `Format to save package as ("image" or "file")`) - cmd.Flags().BoolVar(&flags.Publish, "publish", false, `Publish to registry (applies to "--format=image" only)`) + cmd.Flags().BoolVar(&flags.Publish, "publish", false, `This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others. (applies to "--format=image" only)`) cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") cmd.Flags().StringVarP(&flags.Path, "path", "p", "", "Path to the Buildpack that needs to be packaged") cmd.Flags().StringVarP(&flags.BuildpackRegistry, "buildpack-registry", "r", "", "Buildpack Registry name") diff --git a/internal/commands/create_builder.go b/internal/commands/create_builder.go index a7073da21..ff7128e3e 100644 --- a/internal/commands/create_builder.go +++ b/internal/commands/create_builder.go @@ -89,7 +89,7 @@ Creating a custom builder allows you to control what buildpacks are used and wha cmd.Flags().MarkHidden("buildpack-registry") } cmd.Flags().StringVarP(&flags.BuilderTomlPath, "config", "c", "", "Path to builder TOML file (required)") - cmd.Flags().BoolVar(&flags.Publish, "publish", false, "Publish to registry") + cmd.Flags().BoolVar(&flags.Publish, "publish", false, "This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others.") cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") return cmd } diff --git a/internal/commands/extension_package.go b/internal/commands/extension_package.go index f8d729b2c..85ad7569d 100644 --- a/internal/commands/extension_package.go +++ b/internal/commands/extension_package.go @@ -102,7 +102,7 @@ func ExtensionPackage(logger logging.Logger, cfg config.Config, packager Extensi // flags will be added here cmd.Flags().StringVarP(&flags.PackageTomlPath, "config", "c", "", "Path to package TOML config") cmd.Flags().StringVarP(&flags.Format, "format", "f", "", `Format to save package as ("image" or "file")`) - cmd.Flags().BoolVar(&flags.Publish, "publish", false, `Publish to registry (applies to "--format=image" only)`) + cmd.Flags().BoolVar(&flags.Publish, "publish", false, `This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others. (applies to "--format=image" only)`) cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") AddHelpFlag(cmd, "package") return cmd diff --git a/internal/commands/package_buildpack.go b/internal/commands/package_buildpack.go index e25183336..6b1e339e9 100644 --- a/internal/commands/package_buildpack.go +++ b/internal/commands/package_buildpack.go @@ -85,7 +85,7 @@ func PackageBuildpack(logger logging.Logger, cfg config.Config, packager Buildpa cmd.Flags().StringVarP(&flags.PackageTomlPath, "config", "c", "", "Path to package TOML config (required)") cmd.Flags().StringVarP(&flags.Format, "format", "f", "", `Format to save package as ("image" or "file")`) - cmd.Flags().BoolVar(&flags.Publish, "publish", false, `Publish to registry (applies to "--format=image" only)`) + cmd.Flags().BoolVar(&flags.Publish, "publish", false, `This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others. (applies to "--format=image" only)`) cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") cmd.Flags().StringVarP(&flags.BuildpackRegistry, "buildpack-registry", "r", "", "Buildpack Registry name") diff --git a/internal/commands/rebase.go b/internal/commands/rebase.go index 4219bd0f9..f2765b94b 100644 --- a/internal/commands/rebase.go +++ b/internal/commands/rebase.go @@ -46,7 +46,7 @@ func Rebase(logger logging.Logger, cfg config.Config, pack PackClient) *cobra.Co }), } - cmd.Flags().BoolVar(&opts.Publish, "publish", false, "Publish to registry") + cmd.Flags().BoolVar(&opts.Publish, "publish", false, "This flag triggers the buildpack to publish the built image to a container registry after the build process is complete. This means that the resulting image is pushed to a specified registry, making it available for deployment and use by others.") cmd.Flags().StringVar(&opts.RunImage, "run-image", "", "Run image to use for rebasing") cmd.Flags().StringVar(&policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") cmd.Flags().StringVar(&opts.ReportDestinationDir, "report-output-dir", "", "Path to export build report.toml.\nOmitting the flag yield no report file.")