Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-06 19:05:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate tk docs with cobra/doc

Browse Source
This commit is contained in:
stefanprodan
2020-04-25 20:07:48 +03:00
parent 38cc918a2f
commit 4a872836e3
3 changed files with 34 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
cmd/tk/main.go
View File

@@ -9,6 +9,7 @@ import (
"time"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
"k8s.io/client-go/kubernetes"
_ "k8s.io/client-go/plugin/pkg/client/auth"
"k8s.io/client-go/tools/clientcmd"
@@ -18,7 +19,8 @@ var VERSION = "0.0.1"
var rootCmd = &cobra.Command{
Use: "tk",
Short: "Kubernetes CD assembler",
Short: "Command line utility for assembling Kubernetes CD pipelines",
Long: `Command line utility for assembling Kubernetes CD pipelines.`,
Version: VERSION,
SilenceUsage: true,
SilenceErrors: true,
@@ -31,13 +33,6 @@ var (
)
func init() {
if home := homeDir(); home != "" {
rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", filepath.Join(home, ".kube", "config"),
"path to the kubeconfig file")
} else {
rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", "",
"absolute path to the kubeconfig file")
}
rootCmd.PersistentFlags().StringVarP(&namespace, "namespace", "", "gitops-system",
"the namespace scope for this operation")
rootCmd.PersistentFlags().DurationVarP(&timeout, "timeout", "", 5*time.Minute,
@@ -46,6 +41,8 @@ func init() {
func main() {
log.SetFlags(0)
generateDocs()
kubeconfigFlag()
if err := rootCmd.Execute(); err != nil {
logFailure("%v", err)
os.Exit(1)
@@ -93,3 +90,26 @@ func logSuccess(format string, a ...interface{}) {
func logFailure(format string, a ...interface{}) {
fmt.Println(`✗`, fmt.Sprintf(format, a...))
}
func generateDocs() {
args := os.Args[1:]
if len(args) > 0 && args[0] == "docgen" {
rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", "~/.kube/config",
"path to the kubeconfig file")
err := doc.GenMarkdownTree(rootCmd, "./docs/cmd")
if err != nil {
log.Fatal(err)
}
os.Exit(0)
}
}
func kubeconfigFlag() {
if home := homeDir(); home != "" {
rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", filepath.Join(home, ".kube", "config"),
"path to the kubeconfig file")
} else {
rootCmd.PersistentFlags().StringVarP(&kubeconfig, "kubeconfig", "", "",
"absolute path to the kubeconfig file")
}
}