gitea-mirror/trivy
1
0
Fork 0
mirror of https://github.com/aquasecurity/trivy.git synced 2025-12-22 07:10:41 -08:00
Code Issues Packages Projects Releases Wiki Activity

chore: separate docs:generate (#4242)

Browse Source
This commit is contained in:
Teppei Fukuda
2023-05-10 09:08:31 +03:00
committed by GitHub
parent 37b25d28b2
commit ec3906c24e
2 changed files with 29 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
magefiles/docs.go Normal file
View File

@@ -0,0 +1,28 @@
//go:build mage_docs
package main
import (
"github.com/spf13/cobra/doc"
"github.com/aquasecurity/trivy/pkg/commands"
"github.com/aquasecurity/trivy/pkg/flag"
"github.com/aquasecurity/trivy/pkg/log"
)
// Generate CLI references
func main() {
ver, err := version()
if err != nil {
log.Fatal(err)
}
// Set a dummy path for the documents
flag.CacheDirFlag.Value = "/path/to/cache"
flag.ModuleDirFlag.Value = "$HOME/.trivy/modules"
cmd := commands.NewApp(ver)
cmd.DisableAutoGenTag = true
if err = doc.GenMarkdownTree(cmd, "./docs/docs/references/configuration/cli"); err != nil {
log.Fatal(err)
}
}

19
magefiles/magefile.go
View File

@@ -12,10 +12,6 @@ import (
"github.com/magefile/mage/mg"
"github.com/magefile/mage/sh"
"github.com/magefile/mage/target"
"github.com/spf13/cobra/doc"
"github.com/aquasecurity/trivy/pkg/commands"
"github.com/aquasecurity/trivy/pkg/flag"
)
var (
@@ -344,20 +340,7 @@ func (Docs) Serve() error {
// Generate generates CLI references
func (Docs) Generate() error {
ver, err := version()
if err != nil {
return err
}
// Set a dummy path for the documents
flag.CacheDirFlag.Value = "/path/to/cache"
flag.ModuleDirFlag.Value = "$HOME/.trivy/modules"
cmd := commands.NewApp(ver)
cmd.DisableAutoGenTag = true
if err = doc.GenMarkdownTree(cmd, "./docs/docs/references/configuration/cli"); err != nil {
return err
}
return nil
return sh.RunWith(ENV, "go", "run", "-tags=mage_docs", "./magefiles")
}
func findProtoFiles() ([]string, error) {