Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Keep release visuals near highlights and collapse upgrade guidance

rcourtmancfcc0d00329c
diff --git a/docs/release-control/v6/internal/subsystems/deployment-installability.md b/docs/release-control/v6/internal/subsystems/deployment-installability.md
index 387d975ade..b17e649118 100644
--- a/docs/release-control/v6/internal/subsystems/deployment-installability.md
+++ b/docs/release-control/v6/internal/subsystems/deployment-installability.md
@@ -2801,9 +2801,12 @@ artifact-selection behaviour.
`frontend-modern/src/utils/localStorage.ts` owns that browser-session notice
reservation boundary so the release notice and the GitHub gratitude prompt
cannot create a one-two sequence. The post-update
- surface leads with the authored Highlights, keeps important operator
- information visible, offers current grouped or historical categorized
- details in an expansion, and renders optional `See the difference` images.
+ surface keeps authored Known issues and historical Breaking changes open
+ before the Highlights, with optional `See the difference` images directly
+ after the Highlights. Routine Before-you-upgrade instructions have their own
+ initially collapsed disclosure, separate from the grouped change expansion.
+ Release authors must put critical risks and required safety actions in Known
+ issues so those warnings remain visible without expanding upgrade notes.
Screenshot URLs must be exact-version public release PNG sidecars, never
arbitrary remote images or raw PR attachment URLs. Before/now comparisons
load through the authenticated exact-version release-asset endpoint, which
diff --git a/docs/releases/RELEASE_NOTES_TEMPLATE.md b/docs/releases/RELEASE_NOTES_TEMPLATE.md
index abd3e190ee..acd65f66f0 100644
--- a/docs/releases/RELEASE_NOTES_TEMPLATE.md
+++ b/docs/releases/RELEASE_NOTES_TEMPLATE.md
@@ -46,8 +46,9 @@ receives both. The models decide what to inspect, what matters, and how to tell
the release story. The harness owns the release boundary, public format, safety
constraints, and optional per-pass traces.
-The post-update modal shows Highlights first, followed by optional screenshots
-and expandable grouped changes. Keep the highlights useful without images.
+The post-update modal keeps Known issues visible, followed by Highlights and
+optional screenshots directly underneath. Routine upgrade notes and grouped
+changes have separate disclosures. Keep the highlights useful without images.
The visual investigation also reads the Visual evidence sections and images
from merged PRs in this release range. It may reuse a public GitHub image
attachment or immutable committed screenshot when inspected, safe and still
@@ -63,6 +64,8 @@ be described twice as both an improvement and a fix.
## Known issues
Describe remaining user symptoms and an actionable workaround or next step.
+Put critical risks and required safety actions here so they remain visible in
+the post-update modal, including risks that apply before an upgrade.
Omit this section when there are none. Do not substitute internal verification
status for information users can act on.
@@ -71,6 +74,8 @@ status for information users can act on.
Include only compatibility, migration, signing, companion-app, known-risk, or
required operator information. Omit this section when users do not need to do
or understand anything before upgrading.
+This section is collapsed in the post-update modal. Put critical warnings in
+Known issues rather than relying on an operator expanding these instructions.
The release pipeline appends the `Install` and `Roll back` sections from
governed version metadata. Do not add release qualification, validation,
diff --git a/frontend-modern/browser-verification/2a941cc14b6be9f1.json b/frontend-modern/browser-verification/2a941cc14b6be9f1.json
new file mode 100644
index 0000000000..50bcd46930
--- /dev/null
+++ b/frontend-modern/browser-verification/2a941cc14b6be9f1.json
@@ -0,0 +1,63 @@
+{
+ "version": 1,
+ "base_sha": "6fca29ca8196af9fda30ce89bf66182f09711919",
+ "verified_at": "2026-10-15T12:51:32.759Z",
+ "result": "passed",
+ "changed_paths": [
+ "frontend-modern/src/components/WhatsNewContent.tsx",
+ "frontend-modern/src/components/whatsNewModel.ts"
+ ],
+ "content_sha256": {
+ "frontend-modern/src/components/WhatsNewContent.tsx": "81e78a81d227f83bd3756d0b36fce5564e4b0aecc8b5802527d1fc76fc06ced6",
+ "frontend-modern/src/components/whatsNewModel.ts": "5e4f2069fba15764d898475558b8b361f45bfab674b14a43ce0712ebfa920012"
+ },
+ "routes": [
+ "/proxmox"
+ ],
+ "viewports": [
+ {
+ "width": 1440,
+ "height": 1000
+ },
+ {
+ "width": 390,
+ "height": 844
+ }
+ ],
+ "states": [
+ "non-blocking update notice",
+ "critical known issues and historical breaking changes always expanded",
+ "screenshots immediately after highlights",
+ "upgrade notes collapsed by default",
+ "upgrade and all-changes disclosures independently expanded and collapsed",
+ "before and now images",
+ "current-only image",
+ "no warnings or upgrade notes",
+ "upgrade-only and historical notes",
+ "failed images",
+ "first baseline",
+ "metadata-only release",
+ "release-note fetch error",
+ "dismissed and reloaded"
+ ],
+ "interactions": [
+ "notice click",
+ "pointer and keyboard upgrade disclosure",
+ "All changes disclosure",
+ "scroll to final upgrade instruction and final change",
+ "full-size image link",
+ "focus trap and return",
+ "Escape",
+ "outside click",
+ "close button",
+ "Got it",
+ "notice dismissal",
+ "reload stays quiet"
+ ],
+ "screenshots": [
+ "frontend-modern/browser-verification/screenshots/release-layout-desktop.png",
+ "frontend-modern/browser-verification/screenshots/release-layout-mobile.png",
+ "frontend-modern/browser-verification/screenshots/release-layout-warnings.png"
+ ],
+ "notes": "Current production frontend with a private demo runtime and controlled release transport. Existing beta.3 notes include actual v6.5.0 and updated resource-drawer captures using demo data. Known issues and historical breaking changes remain expanded and appear only once. Upgrade guidance and all changes have independent disclosures."
+}
diff --git a/frontend-modern/browser-verification/screenshots/release-layout-desktop.png b/frontend-modern/browser-verification/screenshots/release-layout-desktop.png
new file mode 100644
index 0000000000..975bf80aaa
Binary files /dev/null and b/frontend-modern/browser-verification/screenshots/release-layout-desktop.png differ
diff --git a/frontend-modern/browser-verification/screenshots/release-layout-mobile.png b/frontend-modern/browser-verification/screenshots/release-layout-mobile.png
new file mode 100644
index 0000000000..98ed99bb94
Binary files /dev/null and b/frontend-modern/browser-verification/screenshots/release-layout-mobile.png differ
diff --git a/frontend-modern/browser-verification/screenshots/release-layout-warnings.png b/frontend-modern/browser-verification/screenshots/release-layout-warnings.png
new file mode 100644
index 0000000000..669e5224d9
Binary files /dev/null and b/frontend-modern/browser-verification/screenshots/release-layout-warnings.png differ
diff --git a/frontend-modern/src/components/WhatsNewContent.tsx b/frontend-modern/src/components/WhatsNewContent.tsx
index 3529bfe2d5..827fe97cfd 100644
--- a/frontend-modern/src/components/WhatsNewContent.tsx
+++ b/frontend-modern/src/components/WhatsNewContent.tsx
@@ -75,6 +75,16 @@ function Screenshot(props: { src: string; title: string; label: string }) {
export function WhatsNewContent(props: { content: ReleaseContent }) {
return (
<div class="space-y-6">
+ <Show when={props.content.important}>
+ {(important) => (
+ <section
+ aria-label="Important release information"
+ class="rounded-lg border border-amber-500/40 bg-amber-500/5 p-4"
+ >
+ <ReleaseText markdown={important()} />
+ </section>
+ )}
+ </Show>
<Show when={props.content.highlights.length > 0}>
<section aria-label="Release highlights">
<h3 class="mb-3 text-xs font-semibold uppercase tracking-wide text-muted">Highlights</h3>
@@ -89,16 +99,6 @@ export function WhatsNewContent(props: { content: ReleaseContent }) {
</ul>
</section>
</Show>
- <Show when={props.content.important}>
- {(important) => (
- <section
- aria-label="Important release information"
- class="rounded-lg border border-border p-4"
- >
- <ReleaseText markdown={important()} />
- </section>
- )}
- </Show>
<For each={props.content.visuals}>
{(visual) => (
<section aria-label={visual.title} class="space-y-3">
@@ -119,6 +119,18 @@ export function WhatsNewContent(props: { content: ReleaseContent }) {
</section>
)}
</For>
+ <Show when={props.content.upgradeNotes}>
+ {(upgradeNotes) => (
+ <details class="group rounded-lg border border-border">
+ <summary class="cursor-pointer rounded-lg px-4 py-3 text-sm font-medium text-base-content focus-visible:outline-solid focus-visible:outline-2 focus-visible:outline-blue-500">
+ Before you upgrade
+ </summary>
+ <div class="border-t border-border p-4">
+ <ReleaseText markdown={upgradeNotes()} />
+ </div>
+ </details>
+ )}
+ </Show>
<Show when={props.content.changes}>
{(changes) => (
<details
diff --git a/frontend-modern/src/components/__tests__/WhatsNewCard.test.tsx b/frontend-modern/src/components/__tests__/WhatsNewCard.test.tsx
index 7656b72cfe..402034943e 100644
--- a/frontend-modern/src/components/__tests__/WhatsNewCard.test.tsx
+++ b/frontend-modern/src/components/__tests__/WhatsNewCard.test.tsx
@@ -207,7 +207,7 @@ describe('WhatsNewCard', () => {
expect(screen.queryByText('All changes')).not.toBeInTheDocument();
});
- it('shows release screenshot comparisons, keeps important information visible and degrades on image failure', async () => {
+ it('puts screenshots under highlights, keeps warnings open and collapses routine upgrade notes', async () => {
localStorage.setItem(STORAGE_KEYS.WHATS_NEW_LAST_SEEN, '6.5.0');
versionInfoMock.mockReturnValue({
version: '6.6.0',
@@ -224,6 +224,10 @@ describe('WhatsNewCard', () => {
'- Open Backups to inspect recent failures.',
'## Known issues',
'Older agents need an update.',
+ '## Breaking changes',
+ 'Migrate the old configuration before enabling collection.',
+ '## Before you upgrade',
+ 'Verify the published checksums.',
'## See the difference',
'### Backup coverage at a glance',
'Compare backup coverage across nodes.',
@@ -237,6 +241,23 @@ describe('WhatsNewCard', () => {
await renderCard();
fireEvent.click(await screen.findByRole('button', { name: "See what's new in Pulse 6.6.0" }));
expect(screen.getByText('Older agents need an update.')).toBeVisible();
+ expect(
+ screen.getByText('Migrate the old configuration before enabling collection.'),
+ ).toBeVisible();
+ const warnings = screen.getByRole('region', { name: 'Important release information' });
+ const highlights = screen.getByRole('region', { name: 'Release highlights' });
+ const comparison = screen.getByRole('region', { name: 'Backup coverage at a glance' });
+ expect(warnings.closest('details')).toBeNull();
+ expect(
+ warnings.compareDocumentPosition(highlights) & Node.DOCUMENT_POSITION_FOLLOWING,
+ ).toBeTruthy();
+ expect(highlights.nextElementSibling).toBe(comparison);
+ const upgradeNotes = screen.getByText('Before you upgrade').closest('details');
+ expect(upgradeNotes).not.toHaveAttribute('open');
+ expect(screen.getByText('Verify the published checksums.')).not.toBeVisible();
+ expect(
+ comparison.compareDocumentPosition(upgradeNotes!) & Node.DOCUMENT_POSITION_FOLLOWING,
+ ).toBeTruthy();
const after = screen.getByRole('img', { name: 'Backup coverage at a glance, now' });
expect(after).toHaveAttribute(
'src',
diff --git a/frontend-modern/src/components/__tests__/whatsNewModel.test.ts b/frontend-modern/src/components/__tests__/whatsNewModel.test.ts
index c0ffb90d70..f35d55d9b0 100644
--- a/frontend-modern/src/components/__tests__/whatsNewModel.test.ts
+++ b/frontend-modern/src/components/__tests__/whatsNewModel.test.ts
@@ -290,7 +290,36 @@ describe('post-update release content', () => {
expect(content?.changes).toContain('Proxmox, PBS and backups');
expect(content?.changes).toContain('Acknowledgements persist');
expect(content?.changes).not.toContain('Internal evidence');
- expect(content?.important).toContain('Update older agents.');
+ expect(content?.upgradeNotes).toBe('Update older agents.');
+ expect(content?.important).toBeNull();
+ });
+
+ it('separates authored warnings from collapsible upgrade instructions', () => {
+ const content = extractWhatsNew(
+ [
+ '## Known issues',
+ '- Do not restart monitoring on an affected guest.',
+ '## Before you upgrade',
+ '- Verify the published checksums.',
+ '## Breaking changes',
+ '- Older configuration needs migration.',
+ ].join('\n'),
+ '6.6.0',
+ );
+ expect(content?.important).toContain('Do not restart monitoring');
+ expect(content?.important).toContain('Older configuration needs migration.');
+ expect(content?.important).not.toContain('published checksums');
+ expect(content?.upgradeNotes).toBe('- Verify the published checksums.');
+ expect(content?.changes).toBeNull();
+ });
+
+ it('preserves upgrade-only releases and historical upgrade headings', () => {
+ for (const heading of ['Before you upgrade', 'Upgrade Notes']) {
+ const content = extractWhatsNew(`## ${heading}\nUse the documented rollback.`, '6.6.0');
+ expect(content?.upgradeNotes).toBe('Use the documented rollback.');
+ expect(content?.important).toBeNull();
+ expect(content?.changes).toBeNull();
+ }
});
it('reads the release tooling before/now Markdown without losing table images', () => {
diff --git a/frontend-modern/src/components/whatsNewModel.ts b/frontend-modern/src/components/whatsNewModel.ts
index 795d5c65be..7b738ea88d 100644
--- a/frontend-modern/src/components/whatsNewModel.ts
+++ b/frontend-modern/src/components/whatsNewModel.ts
@@ -69,7 +69,6 @@ const CHANGELOG_SECTION_LABELS: Readonly<Record<string, string>> = {
fixes: 'Fixed',
'bug fixes': 'Fixed',
security: 'Security',
- 'breaking changes': 'Breaking changes',
deprecated: 'Deprecated',
removed: 'Removed',
'alerts and notifications': 'Alerts and notifications',
@@ -94,6 +93,7 @@ export type WhatsNewContent = {
highlights: string[];
changes: string | null;
important: string | null;
+ upgradeNotes: string | null;
visuals: ReleaseVisual[];
};
@@ -153,26 +153,29 @@ export const extractWhatsNew = (markdown: string, version: string): WhatsNewCont
.slice(0, 3);
const lines = markdown.replace(/\r\n/g, '\n').split('\n');
const headings = headingsIn(lines);
- const importantTitles = new Set(['before you upgrade', 'known issues', 'breaking changes']);
- const important =
+ const sectionMarkdown = (titles: ReadonlySet<string>, includeTitles = true) =>
headings
.flatMap((heading, index) => {
- if (!importantTitles.has(heading.title.toLowerCase())) return [];
+ if (!titles.has(heading.title.toLowerCase())) return [];
const body = sectionBody(lines, headings, index);
- return body ? [`### ${heading.title}\n\n${body}`] : [];
+ return body ? [includeTitles ? `### ${heading.title}\n\n${body}` : body] : [];
})
.join('\n\n') || null;
+ // Authored warning sections stay open. Routine upgrade instructions have
+ // their own disclosure, without inferring severity from individual words.
+ const important = sectionMarkdown(new Set(['known issues', 'breaking changes']));
+ const upgradeNotes = sectionMarkdown(new Set(['before you upgrade', 'upgrade notes']), false);
const changes = extractChangelog(markdown);
const visuals = extractReleaseVisuals(markdown, version);
- return highlights.length || changes || important || visuals.length
- ? { highlights, changes, important, visuals }
+ return highlights.length || changes || important || upgradeNotes || visuals.length
+ ? { highlights, changes, important, upgradeNotes, visuals }
: null;
};
/**
* Build the post-update changelog from the user-facing change categories in a
- * published release body. Highlights and visuals are rendered separately by
- * the post-update view, while this is its expandable detailed changelog.
+ * published release body. Highlights, warnings, upgrade notes and visuals
+ * render separately, while this is its expandable detailed changelog.
*/
export const extractChangelog = (markdown: string): string | null => {
const lines = markdown.replace(/\r\n/g, '\n').split('\n');
@@ -188,7 +191,9 @@ export const extractChangelog = (markdown: string): string | null => {
'highlights',
'see the difference',
'before you upgrade',
+ 'upgrade notes',
'known issues',
+ 'breaking changes',
].includes(normalizedTitle);
if (label || separateSection) {
const boundary = headings.slice(headingIndex + 1).find((next) => next.level <= heading.level);
diff --git a/scripts/generate-release-notes.sh b/scripts/generate-release-notes.sh
index f2ca72a49b..05cebb7cc4 100755
--- a/scripts/generate-release-notes.sh
+++ b/scripts/generate-release-notes.sh
@@ -208,12 +208,16 @@ Each full bullet must be 260 characters or fewer. No semicolons or em dashes.]
## Known issues
[Only unresolved user symptoms with an actionable workaround or next step.
+Include critical risks and required safety actions here, even when they apply
+before upgrading. This section stays visible in the post-update modal.
Omit this section when there are none.]
## Before you upgrade
[Only compatibility, signing, companion-app or required operator information.
-Omit this section when there is none. No internal verification status.]
+Routine upgrade instructions are collapsed in the post-update modal. Put
+critical warnings in Known issues. Omit this section when there is none.
+No internal verification status.]
EOF
fi