Skip to content

A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.

feat: add release list controls and correct board preview colors (#7383)

Thomas0dfd78bde5f7
diff --git a/apps/nextjs/src/components/board/board-layout-thumbnail.tsx b/apps/nextjs/src/components/board/board-layout-thumbnail.tsx
index df6a25613..875b267d7 100644
--- a/apps/nextjs/src/components/board/board-layout-thumbnail.tsx
+++ b/apps/nextjs/src/components/board/board-layout-thumbnail.tsx
@@ -1,11 +1,16 @@
-import { Box, Center, Image } from "@mantine/core";
+"use client";
+
+import { Box, Center, Image, useComputedColorScheme, useMantineTheme, v8CssVariablesResolver } from "@mantine/core";
import { IconLayoutGrid } from "@tabler/icons-react";
import type { BoardPreviewData, BoardPreviewLayout } from "@homarr/boards/layout-preview";
import { projectBoardLayout } from "@homarr/boards/layout-preview";
import { boardLanes, getBoardLaneColumnCount, getRootSectionLane } from "@homarr/definitions";
+import { useSettings } from "@homarr/settings";
import { widgetCatalogIcons } from "@homarr/ui/widget-icons";
+import { generateColorScale } from "~/theme/branding";
+
import classes from "./board-layout-thumbnail.module.css";
interface BoardLayoutThumbnailProps {
@@ -28,12 +33,29 @@ export const BoardLayoutThumbnail = ({
layout: selectedLayout,
sourceLayout,
}: BoardLayoutThumbnailProps) => {
+ const theme = useMantineTheme();
+ const colorScheme = useComputedColorScheme("light");
+ const { branding } = useSettings();
+ let colorVariables;
+ if (preview?.primaryColor) {
+ const primaryColor = branding.lockPrimaryColor ? branding.primaryColor : preview.primaryColor;
+ const variables = v8CssVariablesResolver({
+ ...theme,
+ primaryColor: "boardPreview",
+ colors: { ...theme.colors, boardPreview: generateColorScale(primaryColor) },
+ });
+ colorVariables = Object.fromEntries(
+ Object.entries({ ...variables.variables, ...variables[colorScheme] }).filter(
+ ([key]) => key.startsWith("--mantine-primary-color-") || key.startsWith("--mantine-color-boardPreview-"),
+ ),
+ );
+ }
const canvasClassName = [classes.canvas, className].filter(Boolean).join(" ");
const layout =
selectedLayout ?? preview?.layouts.find((candidate) => candidate.role === "base") ?? preview?.layouts.at(0);
if (!preview || !layout) {
return (
- <Center className={canvasClassName} role="img" aria-label={label}>
+ <Center className={canvasClassName} style={colorVariables} role="img" aria-label={label}>
<IconLayoutGrid size={28} stroke={1.4} aria-hidden />
</Center>
);
@@ -51,7 +73,7 @@ export const BoardLayoutThumbnail = ({
});
if (lanes.length === 0) {
return (
- <Center className={canvasClassName} role="img" aria-label={label}>
+ <Center className={canvasClassName} style={colorVariables} role="img" aria-label={label}>
<IconLayoutGrid size={28} stroke={1.4} aria-hidden />
</Center>
);
@@ -68,7 +90,7 @@ export const BoardLayoutThumbnail = ({
};
return (
- <Box className={canvasClassName} role="img" aria-label={label}>
+ <Box className={canvasClassName} style={colorVariables} role="img" aria-label={label}>
<div
className={classes.lanes}
style={{ gridTemplateColumns: lanes.map(({ columnCount }) => `${columnCount}fr`).join(" ") }}
diff --git a/packages/api/src/router/board.ts b/packages/api/src/router/board.ts
index 885d6bbac..61e217d7b 100644
--- a/packages/api/src/router/board.ts
+++ b/packages/api/src/router/board.ts
@@ -415,6 +415,7 @@ export const boardRouter = createTRPCRouter({
name: true,
logoImageUrl: true,
isPublic: true,
+ primaryColor: true,
},
with: {
creator: {
@@ -652,6 +653,7 @@ export const boardRouter = createTRPCRouter({
isMobileHome: currentUser?.mobileHomeBoardId === board.id,
preview: previewLayout
? {
+ primaryColor: board.primaryColor,
layouts: [previewLayout],
sections: [...previewRoots, ...containerPreview],
items: itemPreview,
diff --git a/packages/api/src/router/widgets/releases.ts b/packages/api/src/router/widgets/releases.ts
index 138275437..a9b3dae6f 100644
--- a/packages/api/src/router/widgets/releases.ts
+++ b/packages/api/src/router/widgets/releases.ts
@@ -52,6 +52,7 @@ export const releasesRouter = createTRPCRouter({
provider: z.enum(releaseProviderKinds),
identifier: z.string(),
versionFilter: releaseVersionFilterSchema.optional(),
+ excludePrereleases: z.boolean().optional(),
providerUrl: z.string().url().optional(),
}),
),
@@ -115,6 +116,7 @@ export const releasesRouter = createTRPCRouter({
provider: repository.provider,
identifier: repository.identifier,
versionRegex: formatVersionFilterRegex(repository.versionFilter),
+ excludePrereleases: repository.excludePrereleases,
providerUrl,
token,
})
diff --git a/packages/boards/src/layout-preview.ts b/packages/boards/src/layout-preview.ts
index 78b47ec7e..e610318dc 100644
--- a/packages/boards/src/layout-preview.ts
+++ b/packages/boards/src/layout-preview.ts
@@ -32,6 +32,7 @@ interface BoardPreviewSectionLayout {
}
export interface BoardPreviewData {
+ primaryColor?: string;
layouts: readonly BoardPreviewLayout[];
sections: readonly BoardPreviewSection[];
items: readonly {
diff --git a/packages/request-handler/src/release-providers/codeberg.ts b/packages/request-handler/src/release-providers/codeberg.ts
index b68d7d99f..61537f211 100644
--- a/packages/request-handler/src/release-providers/codeberg.ts
+++ b/packages/request-handler/src/release-providers/codeberg.ts
@@ -55,9 +55,19 @@ const getProjectDetailsAsync = async (
};
};
-const listReleasesAsync = async (repositoryUrl: string, headers: Record<string, string>, identifier: string) => {
+const listReleasesAsync = async (
+ repositoryUrl: string,
+ headers: Record<string, string>,
+ identifier: string,
+ excludePrereleases = false,
+) => {
+ const releasesUrl = new URL(`${repositoryUrl}/releases`);
+ if (excludePrereleases) {
+ releasesUrl.searchParams.set("pre-release", "false");
+ releasesUrl.searchParams.set("draft", "false");
+ }
try {
- return await fetchJsonAsync(`${repositoryUrl}/releases`, releasesSchema, { headers });
+ return await fetchJsonAsync(releasesUrl.toString(), releasesSchema, { headers });
} catch (error) {
if (!isNotFoundError(error)) throw error;
await fetchProviderAsync(repositoryUrl, { headers });
@@ -65,15 +75,21 @@ const listReleasesAsync = async (repositoryUrl: string, headers: Record<string,
}
};
-export const getCodebergReleaseAsync: ReleaseProvider = async ({ baseUrl, identifier, versionPattern, token }) => {
+export const getCodebergReleaseAsync: ReleaseProvider = async ({
+ baseUrl,
+ identifier,
+ versionPattern,
+ token,
+ excludePrereleases,
+}) => {
const repositoryPath = encodeOwnedName(parseOwnedName(identifier, "owner/repository"));
const repositoryUrl = providerUrl(baseUrl, `/api/v1/repos/${repositoryPath}`);
const headers = tokenHeaders(token, (value) => ({ Authorization: `token ${value}` }));
- const releases = await listReleasesAsync(repositoryUrl, headers, identifier);
- if (releases.length === 0) throw noReleasesFoundError(identifier);
+ const releases = await listReleasesAsync(repositoryUrl, headers, identifier, excludePrereleases);
+ if (releases.length === 0 && !excludePrereleases) throw noReleasesFoundError(identifier);
- const release = selectNewestRelease(releases.map(toRelease), versionPattern);
+ const release = selectNewestRelease(releases.map(toRelease), versionPattern, excludePrereleases);
const details = await loadOptionalDetailsAsync({ baseUrl, identifier, token }, () =>
getProjectDetailsAsync(repositoryUrl, headers),
);
diff --git a/packages/request-handler/src/release-providers/github.ts b/packages/request-handler/src/release-providers/github.ts
index 5870e20c0..8320cf8e7 100644
--- a/packages/request-handler/src/release-providers/github.ts
+++ b/packages/request-handler/src/release-providers/github.ts
@@ -32,7 +32,12 @@ const isReleaseHistoryCap = (error: unknown) =>
error.status === 422 &&
error.message.includes("Only the first 1000 results are available");
-const listReleasesAsync = async (api: Octokit, repository: OwnedName, versionPattern?: RegExp) => {
+const listReleasesAsync = async (
+ api: Octokit,
+ repository: OwnedName,
+ versionPattern?: RegExp,
+ excludePrereleases = false,
+) => {
const releases: GithubRelease[] = [];
try {
for await (const page of api.paginate.iterator(api.rest.repos.listReleases, {
@@ -41,7 +46,16 @@ const listReleasesAsync = async (api: Octokit, repository: OwnedName, versionPat
per_page: getReleasePageSize(versionPattern),
})) {
releases.push(...page.data);
- if (page.data.some((release) => matchesVersionPattern(release.tag_name, versionPattern))) break;
+ if (
+ page.data.some(
+ (release) =>
+ release.published_at &&
+ !release.draft &&
+ (!excludePrereleases || !release.prerelease) &&
+ matchesVersionPattern(release.tag_name, versionPattern),
+ )
+ )
+ break;
}
} catch (error) {
if (!isReleaseHistoryCap(error) || releases.length === 0) throw error;
@@ -54,7 +68,7 @@ const listReleasesAsync = async (api: Octokit, repository: OwnedName, versionPat
};
const toReleases = (release: GithubRelease): Release[] => {
- if (!release.published_at) return [];
+ if (!release.published_at || release.draft) return [];
return [
{
latestRelease: release.tag_name,
@@ -80,14 +94,20 @@ const getProjectDetailsAsync = async (api: Octokit, repository: OwnedName): Prom
};
};
-export const getGithubReleaseAsync: ReleaseProvider = async ({ baseUrl, identifier, versionPattern, token }) => {
+export const getGithubReleaseAsync: ReleaseProvider = async ({
+ baseUrl,
+ identifier,
+ versionPattern,
+ token,
+ excludePrereleases,
+}) => {
const repository = parseOwnedName(identifier, "owner/repository");
const api = createGithubClient(baseUrl, token);
- const releases = await listReleasesAsync(api, repository, versionPattern);
+ const releases = await listReleasesAsync(api, repository, versionPattern, excludePrereleases);
if (releases.length === 0) throw noReleasesFoundError(identifier);
- const release = selectNewestRelease(releases.flatMap(toReleases), versionPattern);
+ const release = selectNewestRelease(releases.flatMap(toReleases), versionPattern, excludePrereleases);
const details = await loadOptionalDetailsAsync({ baseUrl, identifier, token }, () =>
getProjectDetailsAsync(api, repository),
);
diff --git a/packages/request-handler/src/release-providers/index.ts b/packages/request-handler/src/release-providers/index.ts
index 28c19e034..5992db4da 100644
--- a/packages/request-handler/src/release-providers/index.ts
+++ b/packages/request-handler/src/release-providers/index.ts
@@ -34,6 +34,7 @@ const createLookup = (request: ReleasesRepositoryRequest): ReleaseLookup => {
baseUrl: (request.providerUrl ?? getReleaseProviderDefaultUrl(request.provider)).replace(/\/$/, ""),
identifier,
versionPattern: compileVersionPattern(request.versionRegex),
+ excludePrereleases: request.excludePrereleases,
token: request.token,
};
};
diff --git a/packages/request-handler/src/release-providers/types.ts b/packages/request-handler/src/release-providers/types.ts
index 2248a8d49..126c1eb3b 100644
--- a/packages/request-handler/src/release-providers/types.ts
+++ b/packages/request-handler/src/release-providers/types.ts
@@ -5,6 +5,7 @@ export interface ReleasesRepositoryRequest extends Record<string, unknown> {
provider: ReleaseProviderKind;
identifier: string;
versionRegex?: string;
+ excludePrereleases?: boolean;
providerUrl?: string;
token?: string;
}
@@ -50,6 +51,7 @@ export interface ReleaseLookup {
baseUrl: string;
identifier: string;
versionPattern?: RegExp;
+ excludePrereleases?: boolean;
token?: string;
}
diff --git a/packages/request-handler/src/release-providers/versions.ts b/packages/request-handler/src/release-providers/versions.ts
index 6f9b89c25..a53e2a2cf 100644
--- a/packages/request-handler/src/release-providers/versions.ts
+++ b/packages/request-handler/src/release-providers/versions.ts
@@ -56,11 +56,19 @@ export const noReleasesFoundError = (identifier: string) =>
const byNewestRelease = (left: Release, right: Release) =>
right.latestReleaseAt.getTime() - left.latestReleaseAt.getTime();
-export const selectNewestRelease = (releases: Release[], versionPattern?: RegExp): Release => {
+export const selectNewestRelease = (
+ releases: Release[],
+ versionPattern?: RegExp,
+ excludePrereleases = false,
+): Release => {
const [newest] = releases
+ .filter((release) => !excludePrereleases || !release.isPreRelease)
.filter((release) => matchesVersionPattern(release.latestRelease, versionPattern))
.toSorted(byNewestRelease);
if (!newest) {
+ if (excludePrereleases) {
+ throw new ReleaseLookupError("noMatchingVersion", "No stable release matches the configured version filter");
+ }
throw noMatchingVersionError(
releases.map((release) => release.latestRelease),
versionPattern,
diff --git a/packages/translation/src/lang/en.json b/packages/translation/src/lang/en.json
index 322f79af2..21f57a6f4 100644
--- a/packages/translation/src/lang/en.json
+++ b/packages/translation/src/lang/en.json
@@ -4789,6 +4789,10 @@
"hidden": "Hidden"
}
},
+ "groupReleases": {
+ "label": "Group releases by status",
+ "description": "Turn off to show a continuous list without section headings. Collapsed sections are ignored."
+ },
"sections": {
"label": "Sections",
"description": "Groups of repositories to show. Hidden groups are not listed at all."
@@ -4824,7 +4828,7 @@
},
"showChangelogPreview": {
"label": "Show changelog preview",
- "description": "Preview the release notes under new releases."
+ "description": "Preview the release notes under each release."
},
"repositories": {
"label": "Repositories",
@@ -4858,6 +4862,10 @@
"name": {
"label": "Name"
},
+ "excludePrereleases": {
+ "label": "Exclude pre-releases",
+ "description": "Show the latest release not flagged as a pre-release by the provider."
+ },
"versionFilter": {
"label": "Version Filter",
"prefix": {
diff --git a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
index 4664ed93a..9dba2dfca 100644
--- a/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
+++ b/packages/widgets/src/_inputs/widget-multiReleasesRepositories-input.tsx
@@ -105,6 +105,7 @@ export const WidgetMultiReleasesRepositoriesInput = ({
form.setFieldValue(`options.${property}.${index}.identifier`, repository.identifier);
form.setFieldValue(`options.${property}.${index}.name`, repository.name);
form.setFieldValue(`options.${property}.${index}.versionFilter`, repository.versionFilter);
+ form.setFieldValue(`options.${property}.${index}.excludePrereleases`, repository.excludePrereleases);
form.setFieldValue(`options.${property}.${index}.iconUrl`, repository.iconUrl);
form.setFieldValue(`options.${property}.${index}.providerUrl`, repository.providerUrl);
form.setFieldValue(`options.${property}.${index}.integrationIds`, repository.integrationIds);
@@ -564,6 +565,15 @@ const RepositoryEditModal = createModal<RepositoryEditProps>(({ innerProps, acti
</div>
</Group>
+ {tempRepository.provider && ["github", "codeberg"].includes(tempRepository.provider) && (
+ <Checkbox
+ label={tRepository("excludePrereleases.label")}
+ description={tRepository("excludePrereleases.description")}
+ checked={tempRepository.excludePrereleases ?? false}
+ onChange={(event) => handleChange({ excludePrereleases: event.currentTarget.checked })}
+ />
+ )}
+
<Fieldset legend={tRepository("versionFilter.label")}>
<Group justify="stretch" align="center" grow>
<TextInput
diff --git a/packages/widgets/src/releases/component.module.css b/packages/widgets/src/releases/component.module.css
index bda59095f..121d44075 100644
--- a/packages/widgets/src/releases/component.module.css
+++ b/packages/widgets/src/releases/component.module.css
@@ -12,7 +12,7 @@
display: flex;
flex-direction: column;
- justify-content: center;
+ justify-content: flex-start;
gap: rem(10px);
width: 100%;
height: 100%;
@@ -283,6 +283,10 @@
gap: rem(4px);
}
+.list[data-grouped="false"] {
+ gap: rem(1px);
+}
+
.body[data-split] .list {
flex: 0 0 clamp(rem(250px), 38%, rem(400px));
}
@@ -851,11 +855,12 @@
color: var(--releases-warn-text);
}
-.floatingActions {
- position: absolute;
- top: rem(2px);
- right: rem(2px);
- z-index: 1;
+.listActions {
+ display: flex;
+ align-items: center;
+ justify-content: flex-end;
+ gap: rem(6px);
+ flex: none;
}
@keyframes rise {
diff --git a/packages/widgets/src/releases/component.tsx b/packages/widgets/src/releases/component.tsx
index eb4a899da..a212d326a 100644
--- a/packages/widgets/src/releases/component.tsx
+++ b/packages/widgets/src/releases/component.tsx
@@ -69,8 +69,8 @@ const getDensity = (width: number, height: number): Density => {
return "regular";
};
-const getRowVariant = (section: ReleaseSectionKey, density: Density, layout: ReleaseLayout): RowVariant => {
- if (layout === "compact" || section === "upToDate" || section === "quiet") return "dense";
+const getRowVariant = (density: Density, layout: ReleaseLayout): RowVariant => {
+ if (layout === "compact") return "dense";
if (density === "micro") return "mini";
return "rich";
};
@@ -144,6 +144,7 @@ export default function ReleasesWidget({
sections={sections}
collapsedSections={options.collapsedSections}
showChangelogPreview={options.showChangelogPreview}
+ groupReleases={options.groupReleases}
/>
);
}
@@ -162,6 +163,7 @@ interface ReleasesInboxProps {
sections: readonly ReleaseSectionKey[];
collapsedSections: ReleaseSectionKey[];
showChangelogPreview: boolean;
+ groupReleases: boolean;
}
const ReleasesInbox = ({
@@ -178,6 +180,7 @@ const ReleasesInbox = ({
sections,
collapsedSections,
showChangelogPreview,
+ groupReleases,
}: ReleasesInboxProps) => {
const t = useI18n("widget.releases");
const formatter = useFormatter();
@@ -409,23 +412,27 @@ const ReleasesInbox = ({
</header>
)}
- {!showHeader && failedIntegrations.length > 0 && (
- <div className={classes.floatingActions}>
+ {!showHeader && (failedIntegrations.length > 0 || (!groupReleases && newEntries.length > 0)) && (
+ <div className={classes.listActions}>
<IntegrationErrorIndicator results={failedIntegrations} />
+ {!groupReleases && newEntries.length > 0 && (
+ <MarkAllButton placement="section" onClick={handleMarkAllViewed} />
+ )}
</div>
)}
<div className={classes.body} data-split={isSplit || undefined}>
- <div className={classes.list}>
+ <div className={classes.list} data-grouped={groupReleases}>
{releaseSectionKeys.map((key) => {
const section = grouped[key];
const count = section.entries.length + countIssueEntries(section.issues);
if (count === 0) return null;
- const variant = getRowVariant(key, density, layout);
+ const variant = getRowVariant(density, layout);
return (
<Section
key={key}
sectionKey={key}
+ groupReleases={groupReleases}
count={count}
isOpen={isOpen(key)}
onToggle={() => toggleSection(key)}
@@ -473,6 +480,7 @@ const MarkAllButton = ({ placement, onClick }: MarkAllButtonProps) => {
interface SectionProps {
sectionKey: ReleaseSectionKey;
+ groupReleases: boolean;
count: number;
isOpen: boolean;
onToggle: () => void;
@@ -480,8 +488,9 @@ interface SectionProps {
children: ReactNode;
}
-const Section = ({ sectionKey, count, isOpen, onToggle, actions, children }: SectionProps) => {
+const Section = ({ sectionKey, groupReleases, count, isOpen, onToggle, actions, children }: SectionProps) => {
const t = useI18n("widget.releases");
+ if (!groupReleases) return children;
return (
<section className={`releases-section releases-section-${sectionKey} ${classes.section}`}>
diff --git a/packages/widgets/src/releases/index.ts b/packages/widgets/src/releases/index.ts
index 254a83e50..e4ed40d91 100644
--- a/packages/widgets/src/releases/index.ts
+++ b/packages/widgets/src/releases/index.ts
@@ -42,6 +42,10 @@ export const { definition, componentLoader } = createWidgetDefinition("releases"
label: (t) => t(`widget.releases.option.summary.option.${value}`),
})),
}),
+ groupReleases: factory.switch({
+ defaultValue: true,
+ withDescription: true,
+ }),
sections: factory.multiSelect({
defaultValue: [...releaseSectionKeys],
withDescription: true,
@@ -95,6 +99,7 @@ export const { definition, componentLoader } = createWidgetDefinition("releases"
id: z.string().default(() => createId()),
provider: z.enum(releaseProviderKinds).optional(),
identifier: z.string().min(1),
+ excludePrereleases: z.boolean().optional(),
name: z.string().optional(),
versionFilter: z
.object({
diff --git a/packages/widgets/src/releases/releases-repository.ts b/packages/widgets/src/releases/releases-repository.ts
index 22311e76c..952e7e491 100644
--- a/packages/widgets/src/releases/releases-repository.ts
+++ b/packages/widgets/src/releases/releases-repository.ts
@@ -12,6 +12,7 @@ export interface ReleasesRepository {
identifier: string;
name?: string;
versionFilter?: ReleasesVersionFilter;
+ excludePrereleases?: boolean;
iconUrl?: string;
providerUrl?: string;
integrationIds?: string[];
diff --git a/packages/widgets/src/releases/use-release-entries.ts b/packages/widgets/src/releases/use-release-entries.ts
index 2dbd039cd..5cb3a1e73 100644
--- a/packages/widgets/src/releases/use-release-entries.ts
+++ b/packages/widgets/src/releases/use-release-entries.ts
@@ -62,6 +62,7 @@ export const useReleaseEntries = ({
provider,
identifier: repository.identifier,
versionFilter: repository.versionFilter,
+ excludePrereleases: repository.excludePrereleases,
providerUrl: repository.providerUrl,
})),
},