Merge pull request #3852 from buildkite/remove-deprecated-plugin-env-vars

Remove deprecated plugin env vars

Author: DrJosh9000

agent/plugin/error.go

@@ -266,33 +266,6 @@ func flattenConfigToEnvMap(into map[string]string, v any, envPrefix string) erro
 	}
 }
 
-// addDeprecatedEnvVarAliases provides backward compatibility for environment variable names.
-//
-// Before v3.48.0 (https://github.com/buildkite/agent/pull/2116), consecutive underscores in
-// derived env var names were collapsed (e.g., "some--key__name" → SOME_KEY_NAME).
-// Since v3.48.0, consecutive underscores are preserved (e.g., SOME__KEY__NAME).
-//
-// For compatibility, this function adds the collapsed form for any key containing consecutive
-// underscores and returns deprecation errors listing the affected variables.
-func addDeprecatedEnvVarAliases(envMap map[string]string) error {
-	var errs *DeprecatedNameErrors
-	for k, v := range envMap {
-		// the form with consecutive underscores is replacing the form without, but the replacement
-		// is what is expected to be in input map
-		withoutConsecutiveUnderscores := consecutiveUnderscoreRE.ReplaceAllString(k, "_")
-		if k != withoutConsecutiveUnderscores {
-			envMap[withoutConsecutiveUnderscores] = v
-			errs = errs.Append(DeprecatedNameError{old: withoutConsecutiveUnderscores, new: k})
-		}
-	}
-
-	if !errs.IsEmpty() {
-		return errs
-	}
-
-	return nil
-}
-
 // ConfigurationToEnvironment converts the plugin configuration values to environment variables.
 func (p *Plugin) ConfigurationToEnvironment() (*env.Environment, error) {
 	configJSON, err := json.Marshal(p.Configuration)
@@ -309,7 +282,6 @@ func (p *Plugin) ConfigurationToEnvironment() (*env.Environment, error) {
 		return env.New(), err
 	}
 
-	err = addDeprecatedEnvVarAliases(envMap)
 	return env.FromMap(envMap), err
 }
 

agent/plugin/error_test.go

@@ -400,37 +400,18 @@ func TestConfigurationToEnvironment(t *testing.T) {
 			configJSON: `{ "and _ with a    - number": 12 }`,
 			wantEnvMap: map[string]string{
 				"BUILDKITE_PLUGIN_CONFIGURATION":                           `{"and _ with a    - number":12}`,
-				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND_WITH_A_NUMBER":        "12",
 				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND___WITH_A______NUMBER": "12",
 				"BUILDKITE_PLUGIN_NAME":                                    "DOCKER_COMPOSE",
 			},
-			expectedErr: (&DeprecatedNameErrors{}).Append(
-				DeprecatedNameError{
-					old: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND_WITH_A_NUMBER",
-					new: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND___WITH_A______NUMBER",
-				},
-			),
 		},
 		{
 			configJSON: `{ "and _ with a    - number": 12, "A - B": 13 }`,
 			wantEnvMap: map[string]string{
 				"BUILDKITE_PLUGIN_CONFIGURATION":                           `{"A - B":13,"and _ with a    - number":12}`,
-				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND_WITH_A_NUMBER":        "12",
 				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND___WITH_A______NUMBER": "12",
-				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_A_B":                      "13",
 				"BUILDKITE_PLUGIN_DOCKER_COMPOSE_A___B":                    "13",
 				"BUILDKITE_PLUGIN_NAME":                                    "DOCKER_COMPOSE",
 			},
-			expectedErr: (&DeprecatedNameErrors{}).Append(
-				DeprecatedNameError{
-					old: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND_WITH_A_NUMBER",
-					new: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_AND___WITH_A______NUMBER",
-				},
-				DeprecatedNameError{
-					old: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_A_B",
-					new: "BUILDKITE_PLUGIN_DOCKER_COMPOSE_A___B",
-				},
-			),
 		},
 		{
 			configJSON: `{ "bool-true-key": true, "bool-false-key": false }`,

agent/plugin/plugin.go

@@ -255,18 +255,7 @@ func (e *Executor) executePluginHook(ctx context.Context, name string, checkouts
 		hookTypeSeen[name] = true
 
 		envMap, err := p.ConfigurationToEnvironment()
-		if dnerr := (&plugin.DeprecatedNameErrors{}); errors.As(err, &dnerr) {
-			e.shell.Headerf("Deprecated environment variables for plugin %s", p.Plugin.Name())
-			e.shell.Printf("%s", strings.Join([]string{
-				"The way that environment variables are derived from the plugin configuration is changing.",
-				"We'll export both the deprecated and the replacement names for now,",
-				"You may be able to avoid this by removing consecutive underscore, hyphen, or whitespace",
-				"characters in your plugin configuration.",
-			}, " "))
-			for _, err := range dnerr.Unwrap() {
-				e.shell.Printf("%s", err.Error())
-			}
-		} else if err != nil {
+		if err != nil {
 			e.shell.Warningf("Error configuring plugin environment: %s", err)
 		}