From 45a962705444e373e634cb0c47d0f83e9804d1db Mon Sep 17 00:00:00 2001 From: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com> Date: Sat, 24 Aug 2024 09:25:48 +0600 Subject: [PATCH] docs: add pkg flags to config file page (#7370) --- .../references/configuration/config-file.md | 20 +++++++++++++++++++ magefiles/docs.go | 1 + 2 files changed, 21 insertions(+) diff --git a/docs/docs/references/configuration/config-file.md b/docs/docs/references/configuration/config-file.md index 932710f6e2b9..6a54b8e27bdc 100644 --- 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 index bdb85c5357cb..bfdd7480d2a9 100644 --- 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(),