Merge pull request #2046 from carolynvs/backport-stringarray-fix

Backport Switch from StringSlice to StringArray (#1931)
getporter · May 2, 2022 · 678aaf6 · 678aaf6
2 parents 59d55d3 + 9b9f8a1
commit 678aaf6
Show file tree

Hide file tree

Showing 14 changed files with 195 additions and 116 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -60,4 +60,4 @@ and we will add you. **All** contributors belong here. 💯
 * [Saksham Sharma](https://github.com/sakkshm26)
 * [Quentin Petraroia](https://github.com/qpetraroia)
 * [Tamir Kamara](https://github.com/tamirkamara)
-
+* [Chioma Onyekpere](https://github.com/Simpcyclassy)
diff --git a/cmd/porter/bundle.go b/cmd/porter/bundle.go
@@ -142,11 +142,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
-	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
+	f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
 	f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
 		"Specify a driver to use. Allowed values: docker, debug")
@@ -190,11 +190,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
-	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
+	f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
 	f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
 		"Specify a driver to use. Allowed values: docker, debug")
@@ -241,11 +241,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
-	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
+	f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
 	f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
 		"Specify a driver to use. Allowed values: docker, debug")
@@ -292,11 +292,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
-	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
+	f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
 	f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
 		"Specify a driver to use. Allowed values: docker, debug")

diff --git a/docs/content/cli/bundles_install.md b/docs/content/cli/bundles_install.md
@@ -36,18 +36,18 @@ porter bundles install [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for install
-      --insecure-registry          Don't require TLS for the registry
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred stringArray            Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for install
+      --insecure-registry           Don't require TLS for the registry
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_invoke.md b/docs/content/cli/bundles_invoke.md
@@ -36,19 +36,19 @@ porter bundles invoke [INSTALLATION] --action ACTION [flags]
 ### Options
 
 ```
-      --action string              Custom action name to invoke.
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for invoke
-      --insecure-registry          Don't require TLS for the registry
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --action string               Custom action name to invoke.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred stringArray            Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for invoke
+      --insecure-registry           Don't require TLS for the registry
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_uninstall.md b/docs/content/cli/bundles_uninstall.md
@@ -38,20 +38,20 @@ porter bundles uninstall [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-      --delete                     Delete all records associated with the installation, assuming the uninstall action succeeds
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
-      --force                      Force a fresh pull of the bundle
-      --force-delete               UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
-  -h, --help                       help for uninstall
-      --insecure-registry          Don't require TLS for the registry
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred stringArray            Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+      --delete                      Delete all records associated with the installation, assuming the uninstall action succeeds
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
+      --force                       Force a fresh pull of the bundle
+      --force-delete                UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
+  -h, --help                        help for uninstall
+      --insecure-registry           Don't require TLS for the registry
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_upgrade.md b/docs/content/cli/bundles_upgrade.md
@@ -36,18 +36,18 @@ porter bundles upgrade [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for upgrade
-      --insecure-registry          Don't require TLS for the registry
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred stringArray            Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for upgrade
+      --insecure-registry           Don't require TLS for the registry
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/completion.md b/docs/content/cli/completion.md
@@ -9,7 +9,8 @@ Generate completion script
 
 ### Synopsis
 
-Capture the output of the completion command to a file for your shell environment.
+Save the output of this command to a file and load the file into your shell.
+For additional details see: https://porter.sh/install#command-completion
 
 ```
 porter completion [bash|zsh|fish|powershell]