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.

Make release Highlights name concrete changes

[email protected]842dbda6b827
diff --git a/docs/release-control/v6/internal/subsystems/deployment-installability.md b/docs/release-control/v6/internal/subsystems/deployment-installability.md
index 53df551566..a0a4812cc1 100644
--- a/docs/release-control/v6/internal/subsystems/deployment-installability.md
+++ b/docs/release-control/v6/internal/subsystems/deployment-installability.md
@@ -2995,7 +2995,11 @@ artifact-selection behaviour.
For the pre-update preview, release rendering keeps Highlights to at most
three short plain-text bullets of no more than 140
characters each, with links, code, issue references, and nested structure
- reserved for the categorized or full release notes.
+ reserved for the categorized or full release notes. Each Highlights bullet
+ names a specific change and where users find it, never a theme or benefit
+ slogan, because the preview is all a user reads before installing.
+ `scripts/generate-release-notes.sh` and
+ `docs/releases/RELEASE_NOTES_TEMPLATE.md` carry that authoring rule.
The post-update communication boundary does not announce telemetry payload
changes. Those are disclosed in the dated `Payload changes` section of
`docs/PRIVACY.md` and in the release notes of the first release that carries
diff --git a/docs/releases/RELEASE_NOTES_TEMPLATE.md b/docs/releases/RELEASE_NOTES_TEMPLATE.md
index acd65f66f0..82dbcc5f00 100644
--- a/docs/releases/RELEASE_NOTES_TEMPLATE.md
+++ b/docs/releases/RELEASE_NOTES_TEMPLATE.md
@@ -5,8 +5,13 @@ what feels better or works now, not how it was implemented.
## Highlights
-- One to three short plain-text outcomes. Keep each under 140 characters with
- no Markdown, links or issue references so the in-app highlights stay readable.
+- One to three of the release's biggest changes. Name the specific feature or
+ fix and where users find it, for example "Resource Overview shows alerts,
+ recent trends and longer history together", never a theme or benefit slogan
+ such as "See problems and trends together" or "Spend less time on setup".
+ Keep each under 140 characters with no Markdown, links or issue references.
+ The update banner shows these before users install, so each must make sense
+ on its own.
## Proxmox, PBS and backups
@@ -46,9 +51,10 @@ 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 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 post-update dialog is a plain changelog: Known issues first, optional
+screenshots, every change group, then Before you upgrade as Upgrade notes, with
+nothing collapsed. Highlights appear only in the update banner before users
+install, and the dialog shows them only when a release has no change groups.
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
@@ -64,8 +70,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.
+Put critical risks and required safety actions here so they lead the
+post-update changelog, 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.
@@ -74,8 +80,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.
+This section appears last in the post-update changelog as Upgrade notes. Put
+critical warnings in Known issues so they lead instead.
The release pipeline appends the `Install` and `Roll back` sections from
governed version metadata. Do not add release qualification, validation,
diff --git a/scripts/generate-release-notes.sh b/scripts/generate-release-notes.sh
index 05cebb7cc4..4ebbcbb59c 100755
--- a/scripts/generate-release-notes.sh
+++ b/scripts/generate-release-notes.sh
@@ -191,8 +191,13 @@ then
## Highlights
-- [One to three plain-text outcomes, each 140 characters or fewer. No markup,
- links or issue references in this short list.]
+- [One to three of the release's biggest changes, each 140 characters or
+ fewer. Name the specific feature or fix and where users find it, for
+ example: Resource Overview shows alerts, recent trends and longer history
+ together. Never a theme or benefit slogan such as See problems and trends
+ together or Spend less time on setup. These preview the update before it is
+ installed, so each must make sense on its own. No markup, links or issue
+ references in this short list.]
## Proxmox, PBS and backups
@@ -209,14 +214,14 @@ Each full bullet must be 260 characters or fewer. No semicolons or em dashes.]
[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.
+before upgrading. This section leads the post-update changelog.
Omit this section when there are none.]
## Before you upgrade
[Only compatibility, signing, companion-app or required operator information.
-Routine upgrade instructions are collapsed in the post-update modal. Put
-critical warnings in Known issues. Omit this section when there is none.
+It appears last in the post-update changelog as Upgrade notes. Put critical
+warnings in Known issues. Omit this section when there is none.
No internal verification status.]
EOF
fi
diff --git a/scripts/installtests/build_release_assets_test.go b/scripts/installtests/build_release_assets_test.go
index 4d688e094d..f185ecc9df 100644
--- a/scripts/installtests/build_release_assets_test.go
+++ b/scripts/installtests/build_release_assets_test.go
@@ -4949,6 +4949,8 @@ func TestReleaseNotesGeneratorResolvesChannelSpecificComparisonRanges(t *testing
"validate-notes-file /dev/stdin",
"260 characters or fewer",
"Use no semicolon or em dash characters",
+ "Name the specific feature or fix and where users find it",
+ "Never a theme or benefit slogan",
"- **[Short outcome]** - [Where users notice it and why it matters.]",
"requesting one constrained revision",
} {