Skip to content

chore: align active version terminology and link to docs #14639

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.

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
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion cli/templatecreate.go
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ func (r *RootCmd) templateCreate() *serpent.Command {
},
{
Flag: "require-active-version",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.",
Value: serpent.BoolOf(&requireActiveVersion),
Default: "false",
},
Expand Down
2 changes: 1 addition & 1 deletion cli/templateedit.go
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ func (r *RootCmd) templateEdit() *serpent.Command {
},
{
Flag: "require-active-version",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.",
Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.",
Value: serpent.BoolOf(&requireActiveVersion),
Default: "false",
},
Expand Down
4 changes: 3 additions & 1 deletion cli/testdata/coder_templates_create_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ OPTIONS:
--require-active-version bool (default: false)
Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only
feature.
feature. See
https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise
for more details.

--var string-array
Alias of --variable.
Expand Down
4 changes: 3 additions & 1 deletion cli/testdata/coder_templates_edit_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,9 @@ OPTIONS:
--require-active-version bool (default: false)
Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only
feature.
feature. See
https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise
for more details.

-y, --yes bool
Bypass prompts.
Expand Down
Binary file modified docs/images/templates/publish.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/reference/cli/templates_create.md

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

2 changes: 1 addition & 1 deletion docs/reference/cli/templates_edit.md

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

2 changes: 1 addition & 1 deletion docs/templates/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ workspaces.
![Building a template](../images/templates/build-template.png)

Select **Publish version**. In the **Publish new version** dialog, make sure
**Promote to default version** is checked then select **Publish**.
**Promote to active version** is checked then select **Publish**.

![Publish a template](../images/templates/publish.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ manually updated the workspace.

## Updating workspaces

After updating the default version of the template that a workspace was created
After updating the active version of the template that a workspace was created
from, you can update the workspace. Coder will start the workspace with said
version.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,25 @@ import type { PublishVersionData } from "pages/TemplateVersionEditorPage/types";
import type { FC } from "react";
import { getFormHelpers } from "utils/formUtils";
import * as Yup from "yup";
import {
HelpTooltip,
HelpTooltipContent,
HelpTooltipLink,
HelpTooltipLinksGroup,
HelpTooltipText,
HelpTooltipTitle,
HelpTooltipTrigger,
} from "../../components/HelpTooltip/HelpTooltip";
import { docs } from "../../utils/docs";

export const Language = {
versionNameLabel: "Version name",
messagePlaceholder: "Write a short message about the changes you made...",
defaultCheckboxLabel: "Promote to default version",
defaultCheckboxLabel: "Promote to active version",
activeVersionHelpTitle: "Active versions",
activeVersionHelpText:
"Templates can enforce that the active version be used for all workspaces (enterprise-only)",
activeVersionHelpBody: "Review the documentation",
};

export type PublishTemplateVersionDialogProps = DialogProps & {
Expand Down Expand Up @@ -88,22 +102,46 @@ export const PublishTemplateVersionDialog: FC<
rows={5}
/>

<FormControlLabel
label={Language.defaultCheckboxLabel}
control={
<Checkbox
size="small"
checked={form.values.isActiveVersion}
onChange={async (e) => {
await form.setFieldValue(
"isActiveVersion",
e.target.checked,
);
}}
name="isActiveVersion"
/>
}
/>
<Stack direction={"row"}>
<FormControlLabel
label={Language.defaultCheckboxLabel}
control={
<Checkbox
size="small"
checked={form.values.isActiveVersion}
onChange={async (e) => {
await form.setFieldValue(
"isActiveVersion",
e.target.checked,
);
}}
name="isActiveVersion"
/>
}
/>

<HelpTooltip>
<HelpTooltipTrigger />

<HelpTooltipContent>
<HelpTooltipTitle>
{Language.activeVersionHelpTitle}
</HelpTooltipTitle>
<HelpTooltipText>
{Language.activeVersionHelpText}
</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink
href={docs(
"/templates/general-settings#require-automatic-updates-enterprise",
)}
>
{Language.activeVersionHelpBody}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
</HelpTooltipContent>
</HelpTooltip>
</Stack>
</FormFields>
</Stack>
</form>
Expand Down
Loading