mirror of
https://github.com/coder/coder.git
synced 2025-07-13 21:36:50 +00:00
chore: align active version terminology and link to docs (#14639)
This commit is contained in:
@ -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",
|
||||
},
|
||||
|
@ -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",
|
||||
},
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 26 KiB |
2
docs/reference/cli/templates_create.md
generated
2
docs/reference/cli/templates_create.md
generated
@ -95,7 +95,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
|
||||
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.
|
||||
|
||||
### -y, --yes
|
||||
|
||||
|
2
docs/reference/cli/templates_edit.md
generated
2
docs/reference/cli/templates_edit.md
generated
@ -153,7 +153,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This
|
||||
| Type | <code>bool</code> |
|
||||
| Default | <code>false</code> |
|
||||
|
||||
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
|
||||
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.
|
||||
|
||||
### --private
|
||||
|
||||
|
2
docs/templates/tutorial.md
vendored
2
docs/templates/tutorial.md
vendored
@ -111,7 +111,7 @@ workspaces.
|
||||

|
||||
|
||||
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**.
|
||||
|
||||

|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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 & {
|
||||
@ -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>
|
||||
|
Reference in New Issue
Block a user