docs(cli): note --tarball is single-platform-only - #1727
Open
shivanshu877 wants to merge 1 commit into
Open
Conversation
Fixes ko-build#1708. The --tarball flag description used to be just "File to save images tarballs", which reads like it works with the same multi-platform builds ko otherwise supports. The tarball publisher only handles v1.Image (single-platform), not v1.ImageIndex — see pkg/publish/tarball.go, which downcasts the build result and rejects an image index with the comment "there is no way to write an index to a tarball". Extend the flag help to (a) name the format (Docker-save-style), (b) state the single-platform limitation, and (c) point users to --oci-layout-path for multi-platform output. Regenerated the affected docs under docs/reference/ via ./hack/update-codegen.sh. No code behaviour change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1708.
The
--tarballflag description used to be just "File to save images tarballs", which reads like it works with the same multi-platform buildskootherwise supports. The tarball publisher only handlesv1.Image(single-platform), notv1.ImageIndex— seepkg/publish/tarball.go, which downcasts the build result and rejects an image index with the comment "there is no way to write an index to a tarball".Change
Extend the flag help to:
--oci-layout-pathfor multi-platform output.Regenerated the affected docs under
docs/reference/via./hack/update-codegen.sh. No code behaviour change.Verification
./hack/presubmit.sh— cleango test ./pkg/commands/options/...— pass