8000 feat: support markdown in update messages by aslilac · Pull Request #12273 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat: support markdown in update messages #12273

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 5 commits into from
Feb 22, 2024
Merged

feat: support markdown in update messages #12273

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8a9c40d
feat: support markdown in update messages
aslilac Feb 22, 2024
e0a1abd
🧹
aslilac Feb 22, 2024
4b48bfd
update `WorkspaceNotifications`
aslilac Feb 22, 2024
0bdadc7
`ChangeVersionDialog`
aslilac Feb 22, 2024
4f0cea2
🧹
aslilac Feb 22, 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
Prev Previous commit
Next Next commit
ChangeVersionDialog
  • Loading branch information
@aslilac
aslilac committed Feb 22, 2024
commit 0bdadc7371d376df5a91c6c94284a7d410648100
44 changes: 44 additions & 0 deletions site/src/modules/templates/TemplateUpdateMessage.tsx
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { type Interpolation, type Theme } from "@emotion/react";
import { type FC } from "react";
import { MemoizedMarkdown } from "components/Markdown/Markdown";

interface TemplateUpdateMessageProps {
children: string;
}

export const TemplateUpdateMessage: FC<TemplateUpdateMessageProps> = ({
children,
}) => {
return (
<MemoizedMarkdown css={styles.versionMessage}>{children}</MemoizedMarkdown>
);
};

const styles = {
versionMessage: {
fontSize: 14,
lineHeight: 1.2,

"& h1, & h2, & h3, & h4, & h5, & h6": {
margin: "0 0 0.75em",
},
"& h1": {
fontSize: "1.2em",
},
"& h2": {
fontSize: "1.15em",
},
"& h3": {
fontSize: "1.1em",
},
"& h4": {
fontSize: "1.05em",
},
"& h5": {
fontSize: "1em",
},
"& h6": {
fontSize: "0.95em",
},
},
} satisfies Record<string, Interpolation<Theme>>;
36 changes: 3 additions & 33 deletions site/src/pages/TemplateVersionPage/TemplateVersionPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import Button from "@mui/material/Button";
import AddIcon from "@mui/icons-material/Add";
import EditIcon from "@mui/icons-material/Edit";
import { type Interpolation, type Theme } from "@emotion/react";
import { type FC } from "react";
import { Link as RouterLink } from "react-router-dom";
import { Loader } from "components/Loader/Loader";
Expand All @@ -18,7 +17,7 @@ import type { TemplateVersion } from "api/typesGenerated";
import { createDayString } from "utils/createDayString";
import { TemplateVersionFiles } from "utils/templateVersion";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { MemoizedMarkdown } from "components/Markdown/Markdown";
import { TemplateUpdateMessage } from "modules/templates/TemplateUpdateMessage";

export interface TemplateVersionPageViewProps {
versionName: string;
Expand Down Expand Up @@ -73,9 +72,9 @@ export const TemplateVersionPageView: FC<TemplateVersionPageViewProps> = ({
<Stack spacing={4}>
{Boolean(error) && <ErrorAlert error={error} />}
{currentVersion?.message && (
<MemoizedMarkdown css={styles.versionMessage}>
<TemplateUpdateMessage>
{currentVersion.message}
</MemoizedMarkdown>
</TemplateUpdateMessage>
)}
{currentVersion && currentFiles && (
<>
Expand Down Expand Up @@ -111,33 +110,4 @@ export const TemplateVersionPageView: FC<TemplateVersionPageViewProps> = ({
);
};

const styles = {
versionMessage: {
fontSize: "0.9em",
lineHeight: 1.2,

"& h1, & h2, & h3, & h4, & h5, & h6": {
margin: "0 0 0.75em",
},
"& h1": {
fontSize: "1.2em",
},
"& h2": {
fontSize: "1.15em",
},
"& h3": {
fontSize: "1.1em",
},
"& h4": {
fontSize: "1.05em",
},
"& h5": {
fontSize: "1em",
},
"& h6": {
fontSize: "0.95em",
},
},
} satisfies Record<string, Interpolation<Theme>>;

export default TemplateVersionPageView;
49 changes: 49 additions & 0 deletions site/src/pages/WorkspacePage/ChangeVersionDialog.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import {
MockTemplate,
MockTemplateVersion,
MockTemplateVersionWithMarkdownMessage,
} from "testHelpers/entities";
import type { Meta, StoryObj } from "@storybook/react";
import { ChangeVersionDialog } from "./ChangeVersionDialog";

const noMessage = {
...MockTemplateVersion,
message: "",
};

const meta: Meta<typeof ChangeVersionDialog> = {
title: "pages/WorkspacePage/ChangeVersionDialog",
component: ChangeVersionDialog,
args: {
open: true,
template: MockTemplate,
templateVersions: [
MockTemplateVersion,
MockTemplateVersionWithMarkdownMessage,
noMessage,
],
},
};

export default meta;
type Story = StoryObj<typeof ChangeVersionDialog>;

export const NoVersionSelected: Story = {};

export const NoMessage: Story = {
args: {
defaultTemplateVersion: noMessage,
},
};

export const ShortMessage: Story = {
args: {
defaultTemplateVersion: MockTemplateVersion,
},
};

export const LongMessage: Story = {
args: {
defaultTemplateVersion: MockTemplateVersionWithMarkdownMessage,
},
};
24 changes: 14 additions & 10 deletions site/src/pages/WorkspacePage/ChangeVersionDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import { Alert, AlertDetail } from "components/Alert/Alert";
import type { DialogProps } from "components/Dialogs/Dialog";
import { ConfirmDialog } from "components/Dialogs/ConfirmDialog/ConfirmDialog";
import { FormFields } from "components/Form/Form";
import { MemoizedMarkdown } from "components/Markdown/Markdown";
import { Stack } from "components/Stack/Stack";
import { Loader } from "components/Loader/Loader";
import { AvatarData } from "components/AvatarData/AvatarData";
import { Pill } from "components/Pill/Pill";
import { Avatar } from "components/Avatar/Avatar";
import { createDayString } from "utils/createDayString";
import { TemplateUpdateMessage } from "modules/templates/TemplateUpdateMessage";

export type ChangeVersionDialogProps = DialogProps & {
template: Template | undefined;
Expand All @@ -35,7 +35,9 @@ export const ChangeVersionDialog: FC<ChangeVersionDialogProps> = ({
...dialogProps
}) => {
const [isAutocompleteOpen, setIsAutocompleteOpen] = useState(false);
const selectedTemplateVersion = useRef<TemplateVersion | undefined>();
const selectedTemplateVersion = useRef<TemplateVersion | undefined>(
defaultTemplateVersion,
);
const version = selectedTemplateVersion.current;
const validTemplateVersions = templateVersions?.filter((version) => {
return version.job.status === "succeeded";
Expand Down Expand Up @@ -139,16 +141,18 @@ export const ChangeVersionDialog: FC<ChangeVersionDialogProps> = ({
/>
</FormFields>
{version && (
<Alert severity="info">
<AlertTitle>
Published by {version.created_by.username}
</AlertTitle>
<>
{version.message && (
<AlertDetail>
<MemoizedMarkdown>{version.message}</MemoizedMarkdown>
</AlertDetail>
<TemplateUpdateMessage>
{version.message}
</TemplateUpdateMessage>
)}
</Alert>
<Alert severity="info">
<AlertTitle>
Published by {version.created_by.username}
</AlertTitle>
</Alert>
</>
)}
</>
) : (
Expand Down
5 changes: 2 additions & 3 deletions site/src/pages/WorkspacePage/WorkspaceNotifications/WorkspaceNotifications.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
NotificationItem,
Notifications,
} from "./Notifications";
import { TemplateUpdateMessage } from "modules/templates/TemplateUpdateMessage";

type WorkspaceNotificationsProps = {
workspace: Workspace;
Expand Down Expand Up @@ -69,9 +70,7 @@ export const WorkspaceNotifications: FC<WorkspaceNotificationsProps> = ({
title: "An update is available for your workspace",
severity: "info",
detail: (
<MemoizedInlineMarkdown allowedElements={["ol", "ul", "li"]}>
{latestVersion.message}
</MemoizedInlineMarkdown>
<TemplateUpdateMessage>{latestVersion.message}</TemplateUpdateMessage>
),
actions,
});
Expand Down
0