docs: add pkg flags to config file page (aquasecurity#7370)

orizerah · Aug 24, 2024 · 45a9627 · 45a9627
1 parent e9b43f8
commit 45a9627
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/docs/references/configuration/config-file.md b/docs/docs/references/configuration/config-file.md
@@ -431,6 +431,26 @@ module:
   # Same as '--enable-modules'
   enable-modules: []
 
+```
+## Package options
+
+```yaml
+pkg:
+  # Same as '--include-dev-deps'
+  include-dev-deps: false
+
+  # Same as '--pkg-relationships'
+  relationships:
+   - unknown
+   - root
+   - direct
+   - indirect
+
+  # Same as '--pkg-types'
+  types:
+   - os
+   - library
+
 ```
 ## Registry options
 

diff --git a/magefiles/docs.go b/magefiles/docs.go
@@ -69,6 +69,7 @@ func generateConfigDocs(filename string) error {
 		flag.NewLicenseFlagGroup(),
 		flag.NewMisconfFlagGroup(),
 		flag.NewModuleFlagGroup(),
+		flag.NewPackageFlagGroup(),
 		flag.NewRegistryFlagGroup(),
 		flag.NewRegoFlagGroup(),
 		flag.NewReportFlagGroup(),