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

This commit is contained in:
Danny Kopping
2024-09-11 12:25:07 +02:00
committed by GitHub
parent 4f2202fe34
commit 1b5f3418d3
10 changed files with 67 additions and 25 deletions

View File

@ -237,7 +237,7 @@ func (r *RootCmd) templateCreate() *serpent.Command {
}, },
{ {
Flag: "require-active-version", 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), Value: serpent.BoolOf(&requireActiveVersion),
Default: "false", Default: "false",
}, },

View File

@ -290,7 +290,7 @@ func (r *RootCmd) templateEdit() *serpent.Command {
}, },
{ {
Flag: "require-active-version", 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), Value: serpent.BoolOf(&requireActiveVersion),
Default: "false", Default: "false",
}, },

View File

@ -54,7 +54,9 @@ OPTIONS:
--require-active-version bool (default: false) --require-active-version bool (default: false)
Requires workspace builds to use the active template version. This Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only 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 --var string-array
Alias of --variable. Alias of --variable.

View File

@ -86,7 +86,9 @@ OPTIONS:
--require-active-version bool (default: false) --require-active-version bool (default: false)
Requires workspace builds to use the active template version. This Requires workspace builds to use the active template version. This
setting does not apply to template admins. This is an enterprise-only 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 -y, --yes bool
Bypass prompts. Bypass prompts.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -95,7 +95,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted
| Type | <code>bool</code> | | Type | <code>bool</code> |
| Default | <code>false</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 ### -y, --yes

View File

@ -153,7 +153,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This
| Type | <code>bool</code> | | Type | <code>bool</code> |
| Default | <code>false</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 ### --private

View File

@ -111,7 +111,7 @@ workspaces.
![Building a template](../images/templates/build-template.png) ![Building a template](../images/templates/build-template.png)
Select **Publish version**. In the **Publish new version** dialog, make sure 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) ![Publish a template](../images/templates/publish.png)

View File

@ -150,7 +150,7 @@ manually updated the workspace.
## Updating workspaces ## 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 from, you can update the workspace. Coder will start the workspace with said
version. version.

View File

@ -10,11 +10,25 @@ import type { PublishVersionData } from "pages/TemplateVersionEditorPage/types";
import type { FC } from "react"; import type { FC } from "react";
import { getFormHelpers } from "utils/formUtils"; import { getFormHelpers } from "utils/formUtils";
import * as Yup from "yup"; 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 = { export const Language = {
versionNameLabel: "Version name", versionNameLabel: "Version name",
messagePlaceholder: "Write a short message about the changes you made...", 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 & { export type PublishTemplateVersionDialogProps = DialogProps & {
@ -88,22 +102,46 @@ export const PublishTemplateVersionDialog: FC<
rows={5} rows={5}
/> />
<FormControlLabel <Stack direction={"row"}>
label={Language.defaultCheckboxLabel} <FormControlLabel
control={ label={Language.defaultCheckboxLabel}
<Checkbox control={
size="small" <Checkbox
checked={form.values.isActiveVersion} size="small"
onChange={async (e) => { checked={form.values.isActiveVersion}
await form.setFieldValue( onChange={async (e) => {
"isActiveVersion", await form.setFieldValue(
e.target.checked, "isActiveVersion",
); e.target.checked,
}} );
name="isActiveVersion" }}
/> 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> </FormFields>
</Stack> </Stack>
</form> </form>