Skip to content

feat: expose support links as env variables #11697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 19, 2024
Merged

feat: expose support links as env variables #11697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd34973
feat: expose support links as env variables
mtojek Jan 19, 2024
bb10410
golden
mtojek Jan 19, 2024
ec30d1e
table
mtojek Jan 19, 2024
450a7e6
fix test
mtojek Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cli/testdata/coder_server_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions codersdk/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions codersdk/deployment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions docs/cli/server.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions enterprise/cli/testdata/coder_server_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down