feat: allow passing sbomDir to KO #5688
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
A PR to add support for specifying a custom directory for writing SBOM files when using KO.
- Added a "sbom_dir" option in the YAML configuration documentation with a default of "out/sbom".
- Introduced a new SBOMDir field in the Go configuration structure.
- Updated the build options and corresponding tests to support passing the new SBOMDir option.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| www/docs/customization/ko.md | Added documentation for the new "sbom_dir" parameter with explanation and default value. |
| pkg/config/config.go | Extended the configuration struct to include the SBOMDir field. |
| internal/pipe/ko/ko_test.go | Updated tests to include scenarios for the new SBOMDir parameter. |
| internal/pipe/ko/ko.go | Modified the build options logic to include SBOMDir when set and "spdx" is used. |
caarlos0
approved these changes
Mar 28, 2025
caarlos0
reviewed
Mar 28, 2025
caarlos0
reviewed
Mar 28, 2025
| @@ -416,6 +416,7 @@ type Ko struct { | |||
| CreationTime string `yaml:"creation_time,omitempty" json:"creation_time,omitempty"` | |||
| KoDataCreationTime string `yaml:"ko_data_creation_time,omitempty" json:"ko_data_creation_time,omitempty"` | |||
| SBOM string `yaml:"sbom,omitempty" json:"sbom,omitempty"` | |||
There was a problem hiding this comment.
TODO to me: add the valid options of this to the JSONSchema
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5688 +/- ##
==========================================
+ Coverage 83.01% 83.03% +0.02%
==========================================
Files 158 158
Lines 15564 15583 +19
==========================================
+ Hits 12920 12939 +19
Misses 2088 2088
Partials 556 556 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
…t/goreleaser into feat/sbomdir-for-ko
|
Thank you! |
caarlos0
added a commit
that referenced
this pull request
Apr 11, 2025
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.
This commit will allow passing the sbomDir option to KO.
From the KO documentation:
This is useful if you are creating prereleases/snapshots your sbom would be "lost" as it is only published to the local docker registry - and you might use gorelease/ko in your BuildPipelines without docker agent running.
refs https://github.com/orgs/goreleaser/discussions/5679
closes #5689