Skip to content

Commit ed59096

Browse files
docs(cli): added makefile and go file to create docs (#3930)
Co-authored-by: Teppei Fukuda <[email protected]>
1 parent a2f39a3 commit ed59096

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ require (
199199
github.com/containerd/stargz-snapshotter/estargz v0.14.3 // indirect
200200
github.com/containerd/ttrpc v1.1.0 // indirect
201201
github.com/containerd/typeurl v1.0.2 // indirect
202+
github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
202203
github.com/cyphar/filepath-securejoin v0.2.3 // indirect
203204
github.com/davecgh/go-spew v1.1.1 // indirect
204205
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect

go.sum

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,7 @@ github.com/coreos/pkg v0.0.0-20160727233714-3ac0863d7acf/go.mod h1:E3G3o1h8I7cfc
674674
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
675675
github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
676676
github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
677+
github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
677678
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
678679
github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
679680
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=

magefiles/magefile.go

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ import (
1212
"github.com/magefile/mage/mg"
1313
"github.com/magefile/mage/sh"
1414
"github.com/magefile/mage/target"
15+
"github.com/spf13/cobra/doc"
16+
17+
"github.com/aquasecurity/trivy/pkg/commands"
1518
)
1619

1720
var (
@@ -356,7 +359,15 @@ func (Docs) Serve() error {
356359

357360
// Generate generates CLI references
358361
func (Docs) Generate() error {
359-
// TODO
362+
ver, err := version()
363+
if err != nil {
364+
return err
365+
}
366+
cmd := commands.NewApp(ver)
367+
cmd.DisableAutoGenTag = true
368+
if err = doc.GenMarkdownTree(cmd, "./docs/docs/references/cli"); err != nil {
369+
return err
370+
}
360371
return nil
361372
}
362373

0 commit comments

Comments
 (0)