clarify documentation of gitAuthAccessTokenEnvironmentVariable

SasSwart · SasSwart · commit 0c575576124c · 2025-02-17T07:58:20.000Z
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -351,8 +351,11 @@ func tryGettingCoderProviderStacktrace(sess *provisionersdk.Session) string {
 	return string(stacktraces)
 }
 
-// gitAuthAccessTokenEnvironmentVariable was copied from provider.GitAuthAccessTokenEnvironmentVariable
-// in v1.0.4 of github.com/coder/terraform-provider-coder/provider when we upgraded to v2.
+// gitAuthAccessTokenEnvironmentVariable is copied from
+// github.com/coder/terraform-provider-coder/provider.GitAuthAccessTokenEnvironmentVariable@v1.0.4.
+// While removed in v2 of the provider, we keep this to support customers using older templates that
+// depend on this environment variable. Once we are certain that no customers are still using v1 of
+// the provider, we can remove this function.
 func gitAuthAccessTokenEnvironmentVariable(id string) string {
 	return fmt.Sprintf("CODER_GIT_AUTH_ACCESS_TOKEN_%s", id)
 }

Original file line number	Diff line number	Diff line change
`@@ -351,8 +351,11 @@ func tryGettingCoderProviderStacktrace(sess *provisionersdk.Session) string {`
`351`	`351`	`return string(stacktraces)`
`352`	`352`	`}`
`353`	`353`
`354`		`-// gitAuthAccessTokenEnvironmentVariable was copied from provider.GitAuthAccessTokenEnvironmentVariable`
`355`		`-// in v1.0.4 of github.com/coder/terraform-provider-coder/provider when we upgraded to v2.`
	`354`	`+// gitAuthAccessTokenEnvironmentVariable is copied from`
	`355`	`+// github.com/coder/terraform-provider-coder/provider.GitAuthAccessTokenEnvironmentVariable@v1.0.4.`
	`356`	`+// While removed in v2 of the provider, we keep this to support customers using older templates that`
	`357`	`+// depend on this environment variable. Once we are certain that no customers are still using v1 of`
	`358`	`+// the provider, we can remove this function.`
`356`	`359`	`func gitAuthAccessTokenEnvironmentVariable(id string) string {`
`357`	`360`	`return fmt.Sprintf("CODER_GIT_AUTH_ACCESS_TOKEN_%s", id)`
`358`	`361`	`}`