Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up config help text #2347

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clean up config help text #2347

wants to merge 1 commit into from

Conversation

wagoodman
Copy link
Contributor

@wagoodman wagoodman commented Dec 20, 2024

Today we use the options structs from each command registered with clio to build the output of the grype config command. However, not all commands are meant to support options being configured via a config file -- but these are being shown in the grype config output anyway:

# og-config is `grype config` with the latest grype release
# new-config is `grype config` with grype built from this branch
diff /tmp/og-config /tmp/new-config
228,236d227
< 
< # delete downloaded databases after diff occurs (env: GRYPE_DELETE)
< delete: false
< 
< # format to display results (available=[table, json]) (env: GRYPE_OUTPUT)
< Output: 'table'
< 
< # CVE IDs to explain (env: GRYPE_CVE_IDS)
< cve-ids: []

Note that Output is for grype db * commands and there is still an output value documented in the grype config output.

This PR removes all subcommands from consideration when generating grype config output.

Signed-off-by: Alex Goodman <[email protected]>
@wagoodman wagoodman added the bug Something isn't working label Dec 20, 2024
@wagoodman wagoodman enabled auto-merge (squash) December 20, 2024 17:11
@wagoodman wagoodman self-assigned this Dec 20, 2024
@wagoodman wagoodman requested a review from a team December 20, 2024 17:16
@wagoodman wagoodman disabled auto-merge December 20, 2024 18:14
@wagoodman
Copy link
Contributor Author

looks like there is something I didn't take into consideration -- I'll take a closer look later today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

2 participants