-
Notifications
You must be signed in to change notification settings - Fork 30
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
chore: store examples in YAML #271
base: main
Are you sure you want to change the base?
Conversation
c6aebb2
to
9c789af
Compare
Will be ready for review after the release of Trivy v0.57 |
a55cf43
to
d947656
Compare
Signed-off-by: Nikita Pivkin <[email protected]>
d947656
to
25a3a83
Compare
One thing to keep in mind with the examples is the avd generator. I believe it uses the go files as well. Could you confirm that @nikpivkin? |
@simar7 I'll check, but as far as I remember avd-generator uses generated md files. |
avd-generator uses only generated |
Maybe we should change the file schema to the following? id: avdid
examples:
terraform:
cloudformation: This will allow us to associate examples and checks without using the |
In this PR:
cf.go
andtf.go
toyaml
,Although all the examples for a single check are in a single file, we need to reference it from multiple check fields. I suggest adding a new
examples
field that will point to a single file, while maintaining support for the current method of referencing examples for backwards compatibility.Old example files will be deleted in another PR as they are still referenced by Go checks.