diff --git a/ct/cmd/lint.go b/ct/cmd/lint.go index 6580db9c..5783567f 100644 --- a/ct/cmd/lint.go +++ b/ct/cmd/lint.go @@ -62,13 +62,13 @@ func addLintFlags(flags *flag.FlagSet) { is searched in the current directory, '$HOME/.ct', and '/etc/ct', in that order.`)) flags.Bool("validate-maintainers", true, heredoc.Doc(` - Enable validation of maintainer account names in chart.yml (default: true). + Enable validation of maintainer account names in chart.yml. Works for GitHub, GitLab, and Bitbucket`)) - flags.Bool("check-version-increment", true, "Activates a check for chart version increments (default: true)") + flags.Bool("check-version-increment", true, "Activates a check for chart version increments") flags.Bool("validate-chart-schema", true, heredoc.Doc(` - Enable schema validation of 'Chart.yaml' using Yamale (default: true)`)) + Enable schema validation of 'Chart.yaml' using Yamale`)) flags.Bool("validate-yaml", true, heredoc.Doc(` - Enable linting of 'Chart.yaml' and values files (default: true)`)) + Enable linting of 'Chart.yaml' and values files`)) flags.StringSlice("additional-commands", []string{}, heredoc.Doc(` Additional commands to run per chart (default: []) Commands will be executed in the same order as provided in the list and will diff --git a/doc/ct_install.md b/doc/ct_install.md index 262ac3d8..55c9c019 100644 --- a/doc/ct_install.md +++ b/doc/ct_install.md @@ -45,6 +45,7 @@ ct install [flags] --config string Config file --debug Print CLI calls of external tools to stdout (caution: setting this may expose sensitive data when helm-repo-extra-args contains passwords) + --exclude-deprecated Skip charts that are marked as deprecated --excluded-charts strings Charts that should be skipped. May be specified multiple times or separate values with commas --helm-extra-args string Additional arguments for Helm. Must be passed as a single quoted string @@ -74,4 +75,4 @@ ct install [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 25-Sep-2020 +###### Auto generated by spf13/cobra on 28-Oct-2020 diff --git a/doc/ct_lint-and-install.md b/doc/ct_lint-and-install.md index 44242172..4e67e46d 100644 --- a/doc/ct_lint-and-install.md +++ b/doc/ct_lint-and-install.md @@ -13,6 +13,10 @@ ct lint-and-install [flags] ### Options ``` + --additional-commands strings Additional commands to run per chart (default: []) + Commands will be executed in the same order as provided in the list and will + be rendered with go template before being executed. + Example: "helm unittest --helm3 -f tests/*.yaml {{ .Path }}" --all Process all charts except those explicitly excluded. Disables changed charts detection and version increment checking --build-id string An optional, arbitrary identifier that is added to the name of the namespace a @@ -29,10 +33,11 @@ ct lint-and-install [flags] --charts strings Specific charts to test. Disables changed charts detection and version increment checking. May be specified multiple times or separate values with commas - --check-version-increment Activates a check for chart version increments (default: true) (default true) + --check-version-increment Activates a check for chart version increments (default true) --config string Config file --debug Print CLI calls of external tools to stdout (caution: setting this may expose sensitive data when helm-repo-extra-args contains passwords) + --exclude-deprecated Skip charts that are marked as deprecated --excluded-charts strings Charts that should be skipped. May be specified multiple times or separate values with commas --helm-extra-args string Additional arguments for Helm. Must be passed as a single quoted string @@ -59,14 +64,14 @@ ct lint-and-install [flags] --target-branch string The name of the target branch used to identify changed charts (default "master") --upgrade Whether to test an in-place upgrade of each chart from its previous revision if the current version should not introduce a breaking change according to the SemVer spec - --validate-chart-schema Enable schema validation of 'Chart.yaml' using Yamale (default: true) (default true) - --validate-maintainers Enable validation of maintainer account names in chart.yml (default: true). + --validate-chart-schema Enable schema validation of 'Chart.yaml' using Yamale (default true) + --validate-maintainers Enable validation of maintainer account names in chart.yml. Works for GitHub, GitLab, and Bitbucket (default true) - --validate-yaml Enable linting of 'Chart.yaml' and values files (default: true) (default true) + --validate-yaml Enable linting of 'Chart.yaml' and values files (default true) ``` ### SEE ALSO * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 25-Sep-2020 +###### Auto generated by spf13/cobra on 28-Oct-2020 diff --git a/doc/ct_lint.md b/doc/ct_lint.md index 0aa9685a..1c1b11be 100644 --- a/doc/ct_lint.md +++ b/doc/ct_lint.md @@ -26,6 +26,10 @@ ct lint [flags] ### Options ``` + --additional-commands strings Additional commands to run per chart (default: []) + Commands will be executed in the same order as provided in the list and will + be rendered with go template before being executed. + Example: "helm unittest --helm3 -f tests/*.yaml {{ .Path }}" --all Process all charts except those explicitly excluded. Disables changed charts detection and version increment checking --chart-dirs strings Directories containing Helm charts. May be specified multiple times @@ -39,10 +43,11 @@ ct lint [flags] --charts strings Specific charts to test. Disables changed charts detection and version increment checking. May be specified multiple times or separate values with commas - --check-version-increment Activates a check for chart version increments (default: true) (default true) + --check-version-increment Activates a check for chart version increments (default true) --config string Config file --debug Print CLI calls of external tools to stdout (caution: setting this may expose sensitive data when helm-repo-extra-args contains passwords) + --exclude-deprecated Skip charts that are marked as deprecated --excluded-charts strings Charts that should be skipped. May be specified multiple times or separate values with commas --helm-repo-extra-args strings Additional arguments for the 'helm repo add' command to be @@ -58,14 +63,14 @@ ct lint [flags] --remote string The name of the Git remote used to identify changed charts (default "origin") --since string The Git reference used to identify changed charts (default "HEAD") --target-branch string The name of the target branch used to identify changed charts (default "master") - --validate-chart-schema Enable schema validation of 'Chart.yaml' using Yamale (default: true) (default true) - --validate-maintainers Enable validation of maintainer account names in chart.yml (default: true). + --validate-chart-schema Enable schema validation of 'Chart.yaml' using Yamale (default true) + --validate-maintainers Enable validation of maintainer account names in chart.yml. Works for GitHub, GitLab, and Bitbucket (default true) - --validate-yaml Enable linting of 'Chart.yaml' and values files (default: true) (default true) + --validate-yaml Enable linting of 'Chart.yaml' and values files (default true) ``` ### SEE ALSO * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 25-Sep-2020 +###### Auto generated by spf13/cobra on 28-Oct-2020 diff --git a/doc/ct_list-changed.md b/doc/ct_list-changed.md index be3f768e..b46ec16d 100644 --- a/doc/ct_list-changed.md +++ b/doc/ct_list-changed.md @@ -17,6 +17,7 @@ ct list-changed [flags] --chart-dirs strings Directories containing Helm charts. May be specified multiple times or separate values with commas (default [charts]) --config string Config file + --exclude-deprecated Skip charts that are marked as deprecated --excluded-charts strings Charts that should be skipped. May be specified multiple times or separate values with commas -h, --help help for list-changed @@ -31,4 +32,4 @@ ct list-changed [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 25-Sep-2020 +###### Auto generated by spf13/cobra on 28-Oct-2020