diff --git a/Makefile b/Makefile index 98031daec7..adf92c1d12 100644 --- a/Makefile +++ b/Makefile @@ -516,7 +516,7 @@ codegen-api-docs: $(PACKAGE_SHIM) $(GEN_CRD_API_REFERENCE_DOCS) ## Generate API codegen-cli-docs: $(CLI_BIN) ## Generate CLI docs @echo Generate cli docs... >&2 @rm -rf docs/user/cli && mkdir -p docs/user/cli - @$(CLI_BIN) docs -o docs/user/cli + @$(CLI_BIN) docs -o docs/user/cli --autogenTag=false .PHONY: codegen-docs-all codegen-docs-all: codegen-helm-docs codegen-cli-docs codegen-api-docs ## Generate all docs @@ -626,12 +626,12 @@ verify-deepcopy: codegen-deepcopy ## Check deepcopy functions are up to date @git diff --quiet --exit-code api .PHONY: verify-docs -verify-docs: # codegen-docs-all ## Check docs are up to date +verify-docs: codegen-docs-all ## Check docs are up to date @echo Checking docs are up to date... >&2 - @git --no-pager diff docs/user/crd + @git --no-pager diff docs/user @echo 'If this test fails, it is because the git diff is non-empty after running "make codegen-docs-all".' >&2 @echo 'To correct this, locally run "make codegen-docs-all", commit the changes, and re-run tests.' >&2 - @git diff --quiet --exit-code docs/user/crd + @git diff --quiet --exit-code docs/user .PHONY: verify-helm verify-helm: codegen-helm-all ## Check Helm charts are up to date diff --git a/cmd/cli/kubectl-kyverno/docs/docs.go b/cmd/cli/kubectl-kyverno/docs/docs.go index c88b85b007..3ec7dc3647 100644 --- a/cmd/cli/kubectl-kyverno/docs/docs.go +++ b/cmd/cli/kubectl-kyverno/docs/docs.go @@ -43,6 +43,7 @@ func empty(s string) string { func Command(root *cobra.Command) *cobra.Command { var path string var website bool + var autogenTag bool cmd := &cobra.Command{ Use: "docs", Short: "Generates documentation.", @@ -59,11 +60,13 @@ func Command(root *cobra.Command) *cobra.Command { return err } } + root.DisableAutoGenTag = !autogenTag return doc.GenMarkdownTreeCustom(root, path, prepender, linkHandler) }, } cmd.Flags().StringVarP(&path, "output", "o", ".", "Output path") cmd.Flags().BoolVar(&website, "website", false, "Website version") + cmd.Flags().BoolVar(&autogenTag, "autogenTag", true, "Determines if the generated docs should contain a timestamp") if err := cmd.MarkFlagDirname("output"); err != nil { log.Println("WARNING", err) } diff --git a/docs/user/cli/kyverno.md b/docs/user/cli/kyverno.md index 0210e4cdd6..24eb410ab6 100644 --- a/docs/user/cli/kyverno.md +++ b/docs/user/cli/kyverno.md @@ -35,4 +35,3 @@ To enable experimental commands, KYVERNO_EXPERIMENTAL should be configured with * [kyverno test](kyverno_test.md) - Run tests from directory. * [kyverno version](kyverno_version.md) - Shows current version of kyverno. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_apply.md b/docs/user/cli/kyverno_apply.md index 748ddc92ae..10235eeb87 100644 --- a/docs/user/cli/kyverno_apply.md +++ b/docs/user/cli/kyverno_apply.md @@ -136,4 +136,3 @@ More info: https://kyverno.io/docs/kyverno-cli/ * [kyverno](kyverno.md) - Kubernetes Native Policy Management -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_completion.md b/docs/user/cli/kyverno_completion.md index acdf61c0e2..97c1ccff94 100644 --- a/docs/user/cli/kyverno_completion.md +++ b/docs/user/cli/kyverno_completion.md @@ -40,4 +40,3 @@ See each sub-command's help for details on how to use the generated script. * [kyverno completion powershell](kyverno_completion_powershell.md) - Generate the autocompletion script for powershell * [kyverno completion zsh](kyverno_completion_zsh.md) - Generate the autocompletion script for zsh -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_completion_bash.md b/docs/user/cli/kyverno_completion_bash.md index 6fbe62b17a..ea3f9a6026 100644 --- a/docs/user/cli/kyverno_completion_bash.md +++ b/docs/user/cli/kyverno_completion_bash.md @@ -59,4 +59,3 @@ kyverno completion bash * [kyverno completion](kyverno_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_completion_fish.md b/docs/user/cli/kyverno_completion_fish.md index 973c306a7f..eb02a8ae8b 100644 --- a/docs/user/cli/kyverno_completion_fish.md +++ b/docs/user/cli/kyverno_completion_fish.md @@ -50,4 +50,3 @@ kyverno completion fish [flags] * [kyverno completion](kyverno_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_completion_powershell.md b/docs/user/cli/kyverno_completion_powershell.md index 8e28e3fad5..c952046b33 100644 --- a/docs/user/cli/kyverno_completion_powershell.md +++ b/docs/user/cli/kyverno_completion_powershell.md @@ -47,4 +47,3 @@ kyverno completion powershell [flags] * [kyverno completion](kyverno_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_completion_zsh.md b/docs/user/cli/kyverno_completion_zsh.md index 00f343cca3..95a9c9c0d2 100644 --- a/docs/user/cli/kyverno_completion_zsh.md +++ b/docs/user/cli/kyverno_completion_zsh.md @@ -61,4 +61,3 @@ kyverno completion zsh [flags] * [kyverno completion](kyverno_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_create.md b/docs/user/cli/kyverno_create.md index 1f8b56c393..d5b6834f2b 100644 --- a/docs/user/cli/kyverno_create.md +++ b/docs/user/cli/kyverno_create.md @@ -38,4 +38,3 @@ kyverno create [flags] * [kyverno create user-info](kyverno_create_user-info.md) - Create a Kyverno user-info file. * [kyverno create values](kyverno_create_values.md) - Create a Kyverno values file. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_create_metrics-config.md b/docs/user/cli/kyverno_create_metrics-config.md index e175178038..da534c7a58 100644 --- a/docs/user/cli/kyverno_create_metrics-config.md +++ b/docs/user/cli/kyverno_create_metrics-config.md @@ -45,4 +45,3 @@ kyverno create metrics-config -i ns-included-1 -i ns-included-2 -e ns-excluded * [kyverno create](kyverno_create.md) - Provides a command-line interface to help with the creation of various Kyverno resources. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_create_test.md b/docs/user/cli/kyverno_create_test.md index c9f3e6b690..474b12662f 100644 --- a/docs/user/cli/kyverno_create_test.md +++ b/docs/user/cli/kyverno_create_test.md @@ -48,4 +48,3 @@ kyverno create test -p policy.yaml -r resource.yaml -f values.yaml --pass policy * [kyverno create](kyverno_create.md) - Provides a command-line interface to help with the creation of various Kyverno resources. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_create_user-info.md b/docs/user/cli/kyverno_create_user-info.md index e087ae3401..8cec0f413d 100644 --- a/docs/user/cli/kyverno_create_user-info.md +++ b/docs/user/cli/kyverno_create_user-info.md @@ -45,4 +45,3 @@ kyverno create user-info -u molybdenum@somecorp.com -g basic-user -c admin * [kyverno create](kyverno_create.md) - Provides a command-line interface to help with the creation of various Kyverno resources. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_create_values.md b/docs/user/cli/kyverno_create_values.md index 0e1beecc83..50df7ede23 100644 --- a/docs/user/cli/kyverno_create_values.md +++ b/docs/user/cli/kyverno_create_values.md @@ -45,4 +45,3 @@ kyverno create values -g request.mode=dev -n prod,env=prod --rule policy,rule,en * [kyverno create](kyverno_create.md) - Provides a command-line interface to help with the creation of various Kyverno resources. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_docs.md b/docs/user/cli/kyverno_docs.md index 109a3faae5..4f13612938 100644 --- a/docs/user/cli/kyverno_docs.md +++ b/docs/user/cli/kyverno_docs.md @@ -9,6 +9,7 @@ kyverno docs [flags] ### Options ``` + --autogenTag Determines if the generated docs should contain a timestamp (default true) -h, --help help for docs -o, --output string Output path (default ".") --website Website version @@ -36,4 +37,3 @@ kyverno docs [flags] * [kyverno](kyverno.md) - Kubernetes Native Policy Management -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_jp.md b/docs/user/cli/kyverno_jp.md index 51aecebfd0..35682bb7bc 100644 --- a/docs/user/cli/kyverno_jp.md +++ b/docs/user/cli/kyverno_jp.md @@ -42,4 +42,3 @@ kyverno jp [flags] * [kyverno jp parse](kyverno_jp_parse.md) - Parses jmespath expression and shows corresponding AST * [kyverno jp query](kyverno_jp_query.md) - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_jp_function.md b/docs/user/cli/kyverno_jp_function.md index 77493e7623..171037a199 100644 --- a/docs/user/cli/kyverno_jp_function.md +++ b/docs/user/cli/kyverno_jp_function.md @@ -49,4 +49,3 @@ kyverno jp function [function_name]... [flags] * [kyverno jp](kyverno_jp.md) - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_jp_parse.md b/docs/user/cli/kyverno_jp_parse.md index 3973ff6f0b..c14e0b1084 100644 --- a/docs/user/cli/kyverno_jp_parse.md +++ b/docs/user/cli/kyverno_jp_parse.md @@ -59,4 +59,3 @@ kyverno jp parse [-f file|expression]... [flags] * [kyverno jp](kyverno_jp.md) - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_jp_query.md b/docs/user/cli/kyverno_jp_query.md index 20aa98c0dc..8250c659b0 100644 --- a/docs/user/cli/kyverno_jp_query.md +++ b/docs/user/cli/kyverno_jp_query.md @@ -62,4 +62,3 @@ kyverno jp query [-i input] [-q query|query]... [flags] * [kyverno jp](kyverno_jp.md) - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions. -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_test.md b/docs/user/cli/kyverno_test.md index 05f95618cc..811a34eec8 100644 --- a/docs/user/cli/kyverno_test.md +++ b/docs/user/cli/kyverno_test.md @@ -173,4 +173,3 @@ For more information visit https://kyverno.io/docs/kyverno-cli/#test * [kyverno](kyverno.md) - Kubernetes Native Policy Management -###### Auto generated by spf13/cobra on 30-Aug-2023 diff --git a/docs/user/cli/kyverno_version.md b/docs/user/cli/kyverno_version.md index 0e1f0a863e..bec5796ffd 100644 --- a/docs/user/cli/kyverno_version.md +++ b/docs/user/cli/kyverno_version.md @@ -34,4 +34,3 @@ kyverno version [flags] * [kyverno](kyverno.md) - Kubernetes Native Policy Management -###### Auto generated by spf13/cobra on 30-Aug-2023