-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
fix(flag): skip hidden flags for --generate-default-config
command
#8046
Merged
knqyf263
merged 5 commits into
aquasecurity:main
from
DmitriyLewen:fix/default-config-file
Dec 5, 2024
Merged
fix(flag): skip hidden flags for --generate-default-config
command
#8046
knqyf263
merged 5 commits into
aquasecurity:main
from
DmitriyLewen:fix/default-config-file
Dec 5, 2024
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
DmitriyLewen
changed the title
fix(flag): skip hidden flags for
fix(flag): skip hidden flags for Dec 4, 2024
--generate-default-config
flag--generate-default-config
command
knqyf263
reviewed
Dec 5, 2024
pkg/commands/artifact/run.go
Outdated
Comment on lines
364
to
377
for _, k := range viper.AllKeys() { | ||
// Skip the `GenerateDefaultConfigFlag` flags to avoid errors with default config file. | ||
// Users often use "normal" formats instead of compliance. So we'll skip ComplianceFlag | ||
// Also don't keep removed or deprecated flags to avoid confusing users. | ||
if k == flag.GenerateDefaultConfigFlag.ConfigName || k == flag.ComplianceFlag.ConfigName || slices.Contains(hiddenFlags, k) { | ||
continue | ||
} | ||
allFlags[k] = viper.Get(k) | ||
} | ||
|
||
viper.Reset() | ||
for k, v := range allFlags { | ||
viper.Set(k, v) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to reuse the global viper instance? Can't we initiate a new instance?
Suggested change
for _, k := range viper.AllKeys() { | |
// Skip the `GenerateDefaultConfigFlag` flags to avoid errors with default config file. | |
// Users often use "normal" formats instead of compliance. So we'll skip ComplianceFlag | |
// Also don't keep removed or deprecated flags to avoid confusing users. | |
if k == flag.GenerateDefaultConfigFlag.ConfigName || k == flag.ComplianceFlag.ConfigName || slices.Contains(hiddenFlags, k) { | |
continue | |
} | |
allFlags[k] = viper.Get(k) | |
} | |
viper.Reset() | |
for k, v := range allFlags { | |
viper.Set(k, v) | |
} | |
v := viper.New() | |
for _, k := range viper.AllKeys() { | |
// Skip the `GenerateDefaultConfigFlag` flags to avoid errors with default config file. | |
// Users often use "normal" formats instead of compliance. So we'll skip ComplianceFlag | |
// Also don't keep removed or deprecated flags to avoid confusing users. | |
if k == flag.GenerateDefaultConfigFlag.ConfigName || k == flag.ComplianceFlag.ConfigName || slices.Contains(hiddenFlags, k) { | |
continue | |
} | |
v.Set(k, viper.Get(k)) | |
} | |
v.SafeWriteConfigAs("trivy-default.yaml") | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hm.. why not.
Updated in d8c0edf
knqyf263
approved these changes
Dec 5, 2024
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.
Description
Currently we include all flags in the default config.
But Trivy returns an error for removed flags.
Unfortunately
viper
has no options to remove flags, so we need to reset viper and add the required flags to--generate-default-config
Before:
After:
Related issues
--generate-default-config
contains removed and deprecated flags #8043Checklist