Skip to content

Conversation

@nikpivkin
Copy link
Contributor

@nikpivkin nikpivkin commented Jul 8, 2025

Related PRs:

Description

This PR changes how check metadata is loaded by switching to the metadata package from trivy-checks. This reduces the number of dependencies and simplifies future migration from AVD-ID to ID-based referencing.

How to test:

  • Generate the documentation pages as usual.
  • Run a recursive diff between the generated content and the original:
❯ diff -r ~/projects/avd-generator/avd-repo/content/misconfig ~/projects/avd-generator-test/avd-repo/content/misconfig
Only in ~/projects/avd-generator-test/avd-repo/content/misconfig/aws: ami
diff --color -r ~/projects/avd-generator/avd-repo/content/misconfig/aws/api-gateway/avd-aws-0005.md ~/projects/avd-generator-test/avd-repo/content/misconfig/aws/api-gateway/avd-aws-0005.md
2c2
< title: Use Secure TLS Policy
---
> title: Use Secure Tls Policy

As shown above, the only differences are in capitalization (e.g. "TLS" → "Tls") due to the use of a different word casing dictionary. No structural or content-breaking changes are introduced.

For content/compliance only the ID for some checks is changed.

❯ diff -r ~/projects/avd-generator/avd-repo/content/compliance ~/projects/avd-generator-test/avd-repo/content/compliance
diff --color -r ~/projects/avd-generator/avd-repo/content/compliance/kubernetes/CIS Kubernetes Benchmark - RKE2 v1.24-1.24/1.1.10.md ~/projects/avd-generator-test/avd-repo/content/compliance/kubernetes/CIS Kubernetes Benchmark - RKE2 v1.24-1.24/1.1.10.md
29c29
< * [KCV-0057](https://avd.aquasec.com/misconfig/kcv-0057)
---
> * [AVD-KCV-0057](https://avd.aquasec.com/misconfig/avd-kcv-0057)

@nikpivkin nikpivkin requested a review from simar7 July 8, 2025 16:07
Signed-off-by: Nikita Pivkin <[email protected]>
@nikpivkin nikpivkin marked this pull request as ready for review July 16, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant