Add .apko.lock.json to APK control section #802
Draft
Conversation
This file contains 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
This generates the locked apko config for the guest container image that is used to build the APK and puts writes it as .apko.lock.json in the APK's control section. We could alternatively stick this in the (or another) SBOM, but that has triggered false positives with security scanners in the past. Signed-off-by: Jon Johnson <jon.johnson@chainguard.dev>
mattmoor
reviewed
Oct 28, 2023
Comment on lines
+544
to
+556
| ic := bc.ImageConfiguration() | ||
| pkgs, _, err := bc.BuildPackageList(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("resolving package versions: %w", err) | ||
| } | ||
| resolved := make([]string, 0, len(pkgs)) | ||
| for _, pkg := range pkgs { | ||
| resolved = append(resolved, fmt.Sprintf("%s=%s", pkg.Name, pkg.Version)) | ||
| } | ||
| ic.Contents.Packages = resolved | ||
| ic.Archs = []apko_types.Architecture{b.Arch} | ||
| ic.Contents.Repositories = append(ic.Contents.Repositories, b.ExtraRepos...) | ||
| ic.Contents.Keyring = append(ic.Contents.Keyring, b.ExtraKeys...) |
There was a problem hiding this comment.
This seems fine for now, but can I request that we hoist the resolution / locking logic into a shared place so that this and tf-apko and anywhere else we do this don't diverge?
It'd actually also make a great apko sub-comment to produce the resolved config (I know we have show-packages, but I'm thinking something focused around this logic specifically).
mattmoor
reviewed
Oct 28, 2023
| if err != nil { | ||
| return nil, fmt.Errorf("unable to marshal apko config: %w", err) | ||
| } | ||
| if err := fsys.WriteFile(".apko.lock.json", locked, 0644); err != nil { |
There was a problem hiding this comment.
(i know this is a bike-shed, but...) WDYT about .LOCK.apko.json of .BUILDLOCK.apko.json 🤔
My thinking is that we use .apko.yaml elsewhere to indicate things are the apko dialect of yaml. Here it's json, but similar idea. The "build" qualifier is so it's clearer what it's the locked apko configuration of.
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 generates the locked apko config for the guest container image that is used to build the APK and puts writes it as .apko.lock.json in the APK's control section.
We could alternatively stick this in the (or another) SBOM, but that has triggered false positives with security scanners in the past.
Melange Pull Request Template
Functional Changes
Notes:
SCA Changes
Notes:
Linter
Notes: