Add docs to API-level configs #4281
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
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
kzantow
approved these changes
Oct 14, 2025
Contributor
kzantow
left a comment
There was a problem hiding this comment.
I'm not opposed to any of these changes, per-se, but I don't understand the app-config comments, since the two configurations are intentionally decoupled. Maybe a better spot for this would be in the app configuration? It would be useful to see this coupling in syft help.
Contributor
Author
|
I do agree with your points about the awkwardness here, but I currently don't have another better spot to put this information without similar caveats (after chatting through the details offline). I think I'll continue forth with the PR as-is since there is no impact on the movability of this information later (we can always change this later since there is no impact on the API stability or anything like that). |
spiffcs
added a commit
that referenced
this pull request
Oct 22, 2025
* main: chore(deps): update tools to latest versions (#4302) chore(deps): bump github.com/github/go-spdx/v2 from 2.3.3 to 2.3.4 (#4301) chore(deps): bump github/codeql-action from 4.30.8 to 4.30.9 (#4299) support universal (fat) mach-o binary files (#4278) chore(deps): bump sigstore/cosign-installer from 3.10.0 to 4.0.0 (#4296) chore(deps): bump anchore/sbom-action from 0.20.7 to 0.20.8 (#4297) convert posix path back to windows (#4285) Remove duplicate image source providers (#4289) chore(deps): bump anchore/sbom-action from 0.20.6 to 0.20.7 (#4293) feat: add option to fetch remote licenses for pnpm-lock.yaml files (#4286) Add PDM parser (#4234) chore(deps): update tools to latest versions (#4291) fix: panic during java archive maven resolution (#4290) Extract zip archive with multiple entries (#4283) chore: update to use old configuration on new cosign (#4287) chore(deps): update anchore dependencies (#4282) chore(deps): bump github.com/mholt/archives from 0.1.3 to 0.1.5 (#4280) add docs to configs (#4281)
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.
Primarily, this PR makes the following changes:
# app-config: <field>to API-level config fields to map which fields affect application-level configuration. In the near future we can use these in documentation to hint at how the catalogers can be configured.This PR is also setting up for future
pkgtesthelpers were making assumptions about theFoundByfield that were incorrect. When comparing both packages and relationships, you cannot depend on comparing this field if the parser function leans on the generic cataloger capabilities to fill this value in (as they should). For this reason the FoundBy field on a package is now ignored when comparing relationships (but not packages).