feat: expose support links as env variables (#11697)

mtojek · web-flow · commit 89fd29478d61 · 2024-01-19T11:20:36.000+01:00
diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden
@@ -54,6 +54,9 @@ OPTIONS:
           The algorithm to use for generating ssh keys. Accepted values are
           "ed25519", "ecdsa", or "rsa4096".
 
+      --support-links struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS
+          Support links to display in the top right drop down menu.
+
       --update-check bool, $CODER_UPDATE_CHECK (default: false)
           Periodically check for new releases of Coder and inform the owner. The
           check is performed once per day.
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -1793,11 +1793,11 @@ Write out the current server config as YAML to stdout.`,
 		{
 			Name:        "Support Links",
 			Description: "Support links to display in the top right drop down menu.",
+			Env:         "CODER_SUPPORT_LINKS",
+			Flag:        "support-links",
 			YAML:        "supportLinks",
 			Value:       &c.Support.Links,
-			// The support links are hidden until they are defined in the
-			// YAML.
-			Hidden: true,
+			Hidden:      false,
 		},
 		{
 			// Env handling is done in cli.ReadGitAuthFromEnvironment
diff --git a/codersdk/deployment_test.go b/codersdk/deployment_test.go
@@ -65,11 +65,6 @@ func TestDeploymentValues_HighlyConfigurable(t *testing.T) {
 		"External Token Encryption Keys": {
 			yaml: true,
 		},
-		// These complex objects should be configured through YAML.
-		"Support Links": {
-			flag: true,
-			env:  true,
-		},
 		"External Auth Providers": {
 			// Technically External Auth Providers can be provided through the env,
 			// but bypassing clibase. See cli.ReadExternalAuthProvidersFromEnv.
diff --git a/docs/cli/server.md b/docs/cli/server.md
diff --git a/enterprise/cli/testdata/coder_server_--help.golden b/enterprise/cli/testdata/coder_server_--help.golden
@@ -55,6 +55,9 @@ OPTIONS:
           The algorithm to use for generating ssh keys. Accepted values are
           "ed25519", "ecdsa", or "rsa4096".
 
+      --support-links struct[[]codersdk.LinkConfig], $CODER_SUPPORT_LINKS
+          Support links to display in the top right drop down menu.
+
       --update-check bool, $CODER_UPDATE_CHECK (default: false)
           Periodically check for new releases of Coder and inform the owner. The
           check is performed once per day.
