Commit 464a5bc7 authored by Adam Reese's avatar Adam Reese Committed by GitHub

Merge pull request #2266 from adamreese/fix/validate-docs

fix(scripts): don't include plugins for generating docs
parents 986d21b8 a92a3676
......@@ -57,16 +57,13 @@ Environment:
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm reset](helm_reset.md) - uninstalls Tiller from a cluster
* [helm rollback](helm_rollback.md) - roll back a release to a previous revision
* [helm search](helm_search.md) - search for a keyword in charts
* [helm serve](helm_serve.md) - start a local http web server
* [helm status](helm_status.md) - displays the status of the named release
* [helm test](helm_test.md) - test a release
* [helm test](helm_test.md) - test a release
* [helm upgrade](helm_upgrade.md) - upgrade a release
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client/server version information
* [helm version](helm_version.md) - print the client/server version information
###### Auto generated by spf13/cobra on 12-Apr-2017
......@@ -19,8 +19,13 @@ helm test [RELEASE]
### Options
```
--cleanup delete test pods upon completion
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--cleanup delete test pods upon completion
--timeout int time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) (default 300)
--tls enable TLS for request
--tls-ca-cert string path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
--tls-cert string path to TLS certificate file (default "$HELM_HOME/cert.pem")
--tls-key string path to TLS key file (default "$HELM_HOME/key.pem")
--tls-verify enable TLS for request and verify remote
```
### Options inherited from parent commands
......@@ -36,4 +41,4 @@ helm test [RELEASE]
### SEE ALSO
* [helm](helm.md) - The Helm package manager for Kubernetes.
###### Auto generated by spf13/cobra on 11-Mar-2017
###### Auto generated by spf13/cobra on 12-Apr-2017
......@@ -77,7 +77,7 @@ Environment:
.SH SEE ALSO
.PP
\fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-plugin(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP, \fBhelm\-version(1)\fP
\fBhelm\-completion(1)\fP, \fBhelm\-create(1)\fP, \fBhelm\-delete(1)\fP, \fBhelm\-dependency(1)\fP, \fBhelm\-fetch(1)\fP, \fBhelm\-get(1)\fP, \fBhelm\-history(1)\fP, \fBhelm\-home(1)\fP, \fBhelm\-init(1)\fP, \fBhelm\-inspect(1)\fP, \fBhelm\-install(1)\fP, \fBhelm\-lint(1)\fP, \fBhelm\-list(1)\fP, \fBhelm\-package(1)\fP, \fBhelm\-plugin(1)\fP, \fBhelm\-repo(1)\fP, \fBhelm\-reset(1)\fP, \fBhelm\-rollback(1)\fP, \fBhelm\-search(1)\fP, \fBhelm\-serve(1)\fP, \fBhelm\-status(1)\fP, \fBhelm\-test(1)\fP, \fBhelm\-upgrade(1)\fP, \fBhelm\-verify(1)\fP, \fBhelm\-version(1)\fP
.SH HISTORY
......
.TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" ""
.TH "HELM" "1" "Apr 2017" "Auto generated by spf13/cobra" ""
.nh
.ad l
......@@ -31,6 +31,26 @@ The tests to be run are defined in the chart that was installed.
\fB\-\-timeout\fP=300
time in seconds to wait for any individual kubernetes operation (like Jobs for hooks)
.PP
\fB\-\-tls\fP[=false]
enable TLS for request
.PP
\fB\-\-tls\-ca\-cert\fP="$HELM\_HOME/ca.pem"
path to TLS CA certificate file
.PP
\fB\-\-tls\-cert\fP="$HELM\_HOME/cert.pem"
path to TLS certificate file
.PP
\fB\-\-tls\-key\fP="$HELM\_HOME/key.pem"
path to TLS key file
.PP
\fB\-\-tls\-verify\fP[=false]
enable TLS for request and verify remote
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
......@@ -61,4 +81,4 @@ The tests to be run are defined in the chart that was installed.
.SH HISTORY
.PP
11\-Mar\-2017 Auto generated by spf13/cobra
12\-Apr\-2017 Auto generated by spf13/cobra
......@@ -1168,33 +1168,6 @@ _helm_repo()
noun_aliases=()
}
_helm_reset()
{
last_command="helm_reset"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--force")
flags+=("-f")
local_nonpersistent_flags+=("--force")
flags+=("--remove-helm-home")
local_nonpersistent_flags+=("--remove-helm-home")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_reset()
{
last_command="helm_reset"
......@@ -1399,32 +1372,6 @@ _helm_test()
noun_aliases=()
}
_helm_test()
{
last_command="helm_test"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--cleanup")
local_nonpersistent_flags+=("--cleanup")
flags+=("--timeout=")
local_nonpersistent_flags+=("--timeout=")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_upgrade()
{
last_command="helm_upgrade"
......@@ -1513,36 +1460,6 @@ _helm_verify()
noun_aliases=()
}
_helm_version()
{
last_command="helm_version"
commands=()
flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()
flags+=("--client")
flags+=("-c")
local_nonpersistent_flags+=("--client")
flags+=("--server")
flags+=("-s")
local_nonpersistent_flags+=("--server")
flags+=("--short")
local_nonpersistent_flags+=("--short")
flags+=("--debug")
flags+=("--home=")
flags+=("--host=")
flags+=("--kube-context=")
flags+=("--tiller-namespace=")
must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}
_helm_version()
{
last_command="helm_version"
......@@ -1604,17 +1521,14 @@ _helm()
commands+=("plugin")
commands+=("repo")
commands+=("reset")
commands+=("reset")
commands+=("rollback")
commands+=("search")
commands+=("serve")
commands+=("status")
commands+=("test")
commands+=("test")
commands+=("upgrade")
commands+=("verify")
commands+=("version")
commands+=("version")
flags=()
two_word_flags=()
......
......@@ -29,6 +29,8 @@ fi
kube::util::ensure-temp-dir
export HELM_NO_PLUGINS=1
mkdir -p ${KUBE_TEMP}/docs/helm ${KUBE_TEMP}/docs/man/man1 ${KUBE_TEMP}/scripts
bin/helm docs --dir ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/man/man1 --type man
......
......@@ -29,6 +29,8 @@ fi
kube::util::ensure-temp-dir
export HELM_NO_PLUGINS=1
mkdir -p ${KUBE_TEMP}/docs/helm ${KUBE_TEMP}/docs/man/man1 ${KUBE_TEMP}/scripts
bin/helm docs --dir ${KUBE_TEMP}/docs/helm
bin/helm docs --dir ${KUBE_TEMP}/docs/man/man1 --type man
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment