Merge pull request #3136 from hashicorp/deprecate-env-vars

Deprecate `-env-vars` flag in `runner profile set`, replace with `-env-var`

.changelog/3136.txt

@@ -0,0 +1,3 @@
+```release-note:improvement
+cli: `runner profile set` deprecates the `-env-vars` flag in favor of the `-env-var` flag instead.
+```

internal/cli/runner_profile_set.go

@@ -19,9 +19,10 @@ import (
 
 type RunnerProfileSetCommand struct {
  *baseCommand
-
+ //TODO(XX): after `-env-vars` as a slice is deprecated, rename flagEnvVar to flagEnvVars
  flagName string
  flagOCIUrl string
+ flagEnvVar map[string]string
  flagEnvVars []string
  flagPluginType string
  flagPluginConfig string
@@ -175,11 +176,20 @@ func (c *RunnerProfileSetCommand) Run(args []string) int {
  od.EnvironmentVariables = map[string]string{}
  od.Default = c.flagDefault
 
- for _, kv := range c.flagEnvVars {
- idx := strings.IndexByte(kv, '=')
- if idx != -1 {
- od.EnvironmentVariables[kv[:idx]] = kv[idx+1:]
+ if c.flagEnvVars != nil {
+ //TODO(XX): Deprecate -env-vars and this logic
+ c.ui.Output(
+ "Flag '-env-vars' is deprecated, please use flag `-env-var=k=v`",
+ terminal.WithWarningStyle(),
+ )
+ for _, kv := range c.flagEnvVars {
+ idx := strings.IndexByte(kv, '=')
+ if idx != -1 {
+ od.EnvironmentVariables[kv[:idx]] = kv[idx+1:]
+ }
  }
+ } else {
+ od.EnvironmentVariables = c.flagEnvVar
  }
 
  if c.flagPluginType == "" {
@@ -188,7 +198,6 @@ func (c *RunnerProfileSetCommand) Run(args []string) int {
  c.Help(),
  terminal.WithErrorStyle(),
  )
-
  return 1
  }
 
@@ -234,11 +243,18 @@ func (c *RunnerProfileSetCommand) Flags() *flag.Sets {
  Usage: "The url for the OCI image to launch for the on-demand runner.",
  })
 
+ f.StringMapVar(&flag.StringMapVar{
+ Name: "env-var",
+ Target: &c.flagEnvVar,
+ Usage: "Environment variable to expose to the on-demand runner set in 'k=v' format. Typically used to " +
+ "introduce configuration for the plugins that the runner will execute. Can be specified multiple times.",
+ })
+
+ //TODO(XX): deprecate and remove this
  f.StringSliceVar(&flag.StringSliceVar{
  Name: "env-vars",
  Target: &c.flagEnvVars,
- Usage: "Environment variable to expose to the on-demand runner. Typically used to " +
- "introduce configuration for the plugins that the runner will execute. Can be specified multiple times.",
+ Usage: "DEPRECATED. Please see `-env-var`.",
  })
 
  f.StringVar(&flag.StringVar{

website/content/commands/runner-profile-set.mdx

@@ -38,7 +38,8 @@ lifecycle operation.
 
 - `-name=<string>` - The name of an existing runner profile to update.
 - `-oci-url=<string>` - The url for the OCI image to launch for the on-demand runner.
-- `-env-vars=<string>` - Environment variable to expose to the on-demand runner. Typically used to introduce configuration for the plugins that the runner will execute. Can be specified multiple times.
+- `-env-var=<key=value>` - Environment variable to expose to the on-demand runner set in 'k=v' format. Typically used to introduce configuration for the plugins that the runner will execute. Can be specified multiple times.
+- `-env-vars=<string>` - DEPRECATED. Please see `-env-var`.
 - `-plugin-type=<string>` - The type of the plugin to launch for the on-demand runner, such as aws-ecs, kubernetes, etc.
 - `-plugin-config=<string>` - Path to an hcl file that contains the configuration for the plugin. This is only necessary when the plugin's defaults need to be adjusted for the environment the plugin will launch the on-demand runner in.
 - `-default` - Indicates that this remote runner profile should be the default for any project that doesn't otherwise specify its own remote runner.