From f44fea9371a2898aaced941bace962bdf26ef994 Mon Sep 17 00:00:00 2001 From: Ilya Kislenko Date: Fri, 18 Jan 2019 09:17:54 -0700 Subject: [PATCH] Improve help message for --chart-repos flag (#82) Signed-off-by: depohmel --- app/cmd/root.go | 5 +++-- doc/ct.md | 2 +- doc/ct_install.md | 7 ++++--- doc/ct_lint-and-install.md | 7 ++++--- doc/ct_lint.md | 7 ++++--- doc/ct_version.md | 2 +- 6 files changed, 17 insertions(+), 13 deletions(-) diff --git a/app/cmd/root.go b/app/cmd/root.go index 65ac86f..8355cf3 100644 --- a/app/cmd/root.go +++ b/app/cmd/root.go @@ -75,8 +75,9 @@ func addCommonLintAndInstallFlags(flags *pflag.FlagSet) { Directories containing Helm charts. May be specified multiple times or separate values with commas`)) flags.StringSlice("chart-repos", []string{}, heredoc.Doc(` - Additional chart repos to add so dependencies can be resolved. May be - specified multiple times or separate values with commas`)) + Additional chart repositories for dependency resolutions. + Repositories should be formatted as 'name=url' (ex: local=http://127.0.0.1:8879/charts). + May be specified multiple times or separate values with commas`)) flags.StringSlice("helm-repo-extra-args", []string{}, heredoc.Doc(` Additional arguments for the 'helm repo add' command to be specified on a per-repo basis with an equals sign as delimiter diff --git a/doc/ct.md b/doc/ct.md index a21dff8..690ca0e 100644 --- a/doc/ct.md +++ b/doc/ct.md @@ -25,4 +25,4 @@ in given chart directories. * [ct lint-and-install](ct_lint-and-install.md) - Lint, install, and test a chart * [ct version](ct_version.md) - Print version information -###### Auto generated by spf13/cobra on 22-Dec-2018 +###### Auto generated by spf13/cobra on 18-Jan-2019 diff --git a/doc/ct_install.md b/doc/ct_install.md index 49e6a1d..b1d8760 100644 --- a/doc/ct_install.md +++ b/doc/ct_install.md @@ -32,8 +32,9 @@ ct install [flags] the ID of a pull request. If not specified, the name of the chart is used --chart-dirs strings Directories containing Helm charts. May be specified multiple times or separate values with commas (default [charts]) - --chart-repos strings Additional chart repos to add so dependencies can be resolved. May be - specified multiple times or separate values with commas + --chart-repos strings Additional chart repositories for dependency resolutions. + Repositories should be formatted as 'name=url' (ex: local=http://127.0.0.1:8879/charts). + May be specified multiple times or separate values with commas --charts strings Specific charts to test. Disables changed charts detection and version increment checking. May be specified multiple times or separate values with commas @@ -61,4 +62,4 @@ ct install [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 22-Dec-2018 +###### Auto generated by spf13/cobra on 18-Jan-2019 diff --git a/doc/ct_lint-and-install.md b/doc/ct_lint-and-install.md index dc6d581..655e072 100644 --- a/doc/ct_lint-and-install.md +++ b/doc/ct_lint-and-install.md @@ -20,8 +20,9 @@ ct lint-and-install [flags] the ID of a pull request. If not specified, the name of the chart is used --chart-dirs strings Directories containing Helm charts. May be specified multiple times or separate values with commas (default [charts]) - --chart-repos strings Additional chart repos to add so dependencies can be resolved. May be - specified multiple times or separate values with commas + --chart-repos strings Additional chart repositories for dependency resolutions. + Repositories should be formatted as 'name=url' (ex: local=http://127.0.0.1:8879/charts). + May be specified multiple times or separate values with commas --chart-yaml-schema string The schema for chart.yml validation. If not specified, 'chart_schema.yaml' is searched in the current directory, '$HOME/.ct', and '/etc/ct', in that order. @@ -60,4 +61,4 @@ ct lint-and-install [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 22-Dec-2018 +###### Auto generated by spf13/cobra on 18-Jan-2019 diff --git a/doc/ct_lint.md b/doc/ct_lint.md index 08d46ef..feee273 100644 --- a/doc/ct_lint.md +++ b/doc/ct_lint.md @@ -30,8 +30,9 @@ ct lint [flags] Disables changed charts detection and version increment checking --chart-dirs strings Directories containing Helm charts. May be specified multiple times or separate values with commas (default [charts]) - --chart-repos strings Additional chart repos to add so dependencies can be resolved. May be - specified multiple times or separate values with commas + --chart-repos strings Additional chart repositories for dependency resolutions. + Repositories should be formatted as 'name=url' (ex: local=http://127.0.0.1:8879/charts). + May be specified multiple times or separate values with commas --chart-yaml-schema string The schema for chart.yml validation. If not specified, 'chart_schema.yaml' is searched in the current directory, '$HOME/.ct', and '/etc/ct', in that order. @@ -64,4 +65,4 @@ ct lint [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 22-Dec-2018 +###### Auto generated by spf13/cobra on 18-Jan-2019 diff --git a/doc/ct_version.md b/doc/ct_version.md index b1bcd34..b4e1059 100644 --- a/doc/ct_version.md +++ b/doc/ct_version.md @@ -20,4 +20,4 @@ ct version [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 22-Dec-2018 +###### Auto generated by spf13/cobra on 18-Jan-2019