From 92130d91ba30fe142b9a1fa677444fbcaea7bdcf Mon Sep 17 00:00:00 2001 From: Mark Furland Date: Mon, 11 May 2020 14:08:55 -0400 Subject: [PATCH] Minimal manpage generation from cobra --- .gitignore | 2 ++ .goreleaser.yml | 4 ++++ Makefile | 8 ++++++++ cmd/gen-docs/main.go | 5 +++++ 4 files changed, 19 insertions(+) diff --git a/.gitignore b/.gitignore index 5ef399ba7..80891986e 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,5 @@ .DS_Store vendor/ + +manpage diff --git a/.goreleaser.yml b/.goreleaser.yml index 8fca69fb3..4ceeee571 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -35,6 +35,8 @@ archives: replacements: darwin: macOS format: tar.gz + files: + - manpage/gh*.1 - id: windows builds: [windows] <<: *archive_defaults @@ -76,6 +78,8 @@ nfpms: formats: - deb - rpm + files: + "./manpage/gh*.1": "/usr/share/man/man1" scoop: bucket: diff --git a/Makefile b/Makefile index f2b4805c8..9dc9aae50 100644 --- a/Makefile +++ b/Makefile @@ -44,3 +44,11 @@ endif git -C site commit -m '$(GITHUB_REF:refs/tags/v%=%)' index.html git -C site push .PHONY: site-publish + + +manpage: + mkdir -p $@ + +.PHONY: manpages +manpages: manpage + go run ./cmd/gen-docs ./manpage diff --git a/cmd/gen-docs/main.go b/cmd/gen-docs/main.go index 6607054a9..82efa58f9 100644 --- a/cmd/gen-docs/main.go +++ b/cmd/gen-docs/main.go @@ -24,6 +24,11 @@ func main() { if err != nil { fatal(err) } + + err = doc.GenManTree(command.RootCmd, nil, dir) + if err != nil { + fatal(err) + } } func filePrepender(filename string) string {