fix: correct --sbom-dir flag description (file → directory)#1648
Merged
imjasonh merged 1 commit intoko-build:mainfrom May 9, 2026
Merged
fix: correct --sbom-dir flag description (file → directory)#1648imjasonh merged 1 commit intoko-build:mainfrom
imjasonh merged 1 commit intoko-build:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request fixes an incorrect CLI help/flag description for --sbom-dir, clarifying that the flag value is a directory (not a file), and updates the generated reference docs accordingly.
Changes:
- Update the
--sbom-dirflag help text from “Path to file …” to “Path to directory …”. - Regenerate/update the CLI reference docs so all command pages reflect the corrected description.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/commands/options/build.go | Corrects the --sbom-dir cobra flag description to indicate a directory. |
| docs/reference/ko_build.md | Updates generated CLI docs for ko build to reflect the corrected --sbom-dir description. |
| docs/reference/ko_run.md | Updates generated CLI docs for ko run to reflect the corrected --sbom-dir description. |
| docs/reference/ko_resolve.md | Updates generated CLI docs for ko resolve to reflect the corrected --sbom-dir description. |
| docs/reference/ko_create.md | Updates generated CLI docs for ko create to reflect the corrected --sbom-dir description. |
| docs/reference/ko_apply.md | Updates generated CLI docs for ko apply to reflect the corrected --sbom-dir description. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
imjasonh
approved these changes
May 9, 2026
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
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.
--sbom-dirhas been described as "Path to file where the SBOM will be written." since it landed in #822 — but the flag is clearly a directory, not a file.How to reproduce:
The impl literally does
os.MkdirAllon the value and then drops files inside it:Even the field is named
SBOMDirand the flag is--sbom-dirlol.Fix: one-word change in the flag description (
file→directory) + regenerated docs via./hack/update-codegen.sh. No behavior change../hack/presubmit.shpasses.