docs: Improve documentation for --publish flag #2024

rizul2108 · 2024-01-13T18:14:31Z

Summary

I am changing the help-text for --publish flag as it was not properly descriptive earlier.

Resolves #1994

Signed-off-by: Rizul Gupta <mail2rizul@gmail.com>

codecov · 2024-01-13T18:26:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5dffab6) 79.50% compared to head (d27f8d8) 79.50%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2024   +/-   ##
=======================================
  Coverage   79.50%   79.50%           
=======================================
  Files         175      175           
  Lines       13114    13114           
=======================================
  Hits        10425    10425           
  Misses       2022     2022           
  Partials      667      667

Flag	Coverage Δ
os_linux	`78.42% <100.00%> (ø)`
os_macos	`76.24% <100.00%> (ø)`
os_windows	`78.88% <100.00%> (ø)`
unit	`79.50% <100.00%> (ø)`

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

internal/commands/build.go

internal/commands/builder_create.go

internal/commands/buildpack_package.go

internal/commands/create_builder.go

internal/commands/extension_package.go

internal/commands/package_buildpack.go

internal/commands/rebase.go

natalieparellano

@rizul2108 - thanks a lot for this. I left some suggestions. I avoided using making it available for deployment and use by others because that is sort of subjective, users can have private registries with access controls and we don't want to imply that the image will automatically be made "public". LMK what you think :)

rizul2108 · 2024-01-17T17:23:02Z

@rizul2108 - thanks a lot for this. I left some suggestions. I avoided using making it available for deployment and use by others because that is sort of subjective, users can have private registries with access controls and we don't want to imply that the image will automatically be made "public". LMK what you think :)

Yeah I missed that point that it can be published to private registries also.I agree about that point.

Co-authored-by: Natalie Arellano <narellano@vmware.com> Signed-off-by: Rizul Gupta <112455393+rizul2108@users.noreply.github.com>

rizul2108 · 2024-01-18T09:36:45Z

@natalieparellano can you please review now I committed your suggested changes

jjbustamante · 2024-01-18T20:42:13Z

@rizul2108 thank you so much for this contribution!!

jjbustamante

LGTM

cmoulliard · 2024-01-22T15:38:47Z

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, "Publish the application image directly to the container registry specified in <image-name>, instead of the daemon. The run image must also reside in the registry.")


Why do you say that the The run image must also reside in the registry ? AFAIK pack build or pack builder build and push image according to toml file definition and application path but I never see something about to have a run image .... @jjbustamante

rizul2108 requested review from a team as code owners January 13, 2024 18:14

github-actions bot added this to the 0.33.0 milestone Jan 13, 2024

github-actions bot added the type/enhancement Issue that requests a new feature or improvement. label Jan 13, 2024

change help text of --publish

577880f

Signed-off-by: Rizul Gupta <mail2rizul@gmail.com>

rizul2108 force-pushed the improve-doc-publish branch from c3605d2 to 577880f Compare January 13, 2024 18:16