mirror of
https://github.com/aquasecurity/trivy.git
synced 2025-12-22 15:16:33 -08:00
chore: separate docs:generate (#4242)
This commit is contained in:
28
magefiles/docs.go
Normal file
28
magefiles/docs.go
Normal 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -12,10 +12,6 @@ import (
|
|||||||
"github.com/magefile/mage/mg"
|
"github.com/magefile/mage/mg"
|
||||||
"github.com/magefile/mage/sh"
|
"github.com/magefile/mage/sh"
|
||||||
"github.com/magefile/mage/target"
|
"github.com/magefile/mage/target"
|
||||||
"github.com/spf13/cobra/doc"
|
|
||||||
|
|
||||||
"github.com/aquasecurity/trivy/pkg/commands"
|
|
||||||
"github.com/aquasecurity/trivy/pkg/flag"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@@ -344,20 +340,7 @@ func (Docs) Serve() error {
|
|||||||
|
|
||||||
// Generate generates CLI references
|
// Generate generates CLI references
|
||||||
func (Docs) Generate() error {
|
func (Docs) Generate() error {
|
||||||
ver, err := version()
|
return sh.RunWith(ENV, "go", "run", "-tags=mage_docs", "./magefiles")
|
||||||
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
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func findProtoFiles() ([]string, error) {
|
func findProtoFiles() ([]string, error) {
|
||||||
|
|||||||
Reference in New Issue
Block a user