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 a real change out of the Highlights example

[email protected]c4486a177a4a
diff --git a/docs/release-control/v6/internal/subsystems/deployment-installability.md b/docs/release-control/v6/internal/subsystems/deployment-installability.md
index f02af499a6..9b586b1e3f 100644
--- a/docs/release-control/v6/internal/subsystems/deployment-installability.md
+++ b/docs/release-control/v6/internal/subsystems/deployment-installability.md
@@ -2999,7 +2999,8 @@ artifact-selection behaviour.
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.
+ `docs/releases/RELEASE_NOTES_TEMPLATE.md` carry that authoring rule as
+ the shape of a bullet, not a shipped change a later release could copy.
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 82dbcc5f00..1ce07d8a11 100644
--- a/docs/releases/RELEASE_NOTES_TEMPLATE.md
+++ b/docs/releases/RELEASE_NOTES_TEMPLATE.md
@@ -6,9 +6,10 @@ what feels better or works now, not how it was implemented.
## Highlights
- 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".
+ fix and where users find it, starting with the page or feature and then
+ saying what it now does. Describe only changes in this release, 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.
diff --git a/scripts/generate-release-notes.sh b/scripts/generate-release-notes.sh
index 4ebbcbb59c..961cb7edb1 100755
--- a/scripts/generate-release-notes.sh
+++ b/scripts/generate-release-notes.sh
@@ -192,12 +192,13 @@ then
## Highlights
- [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.]
+ fewer. Name the specific feature or fix and where users find it, starting
+ with the page or feature and then saying what it now does.
+ Describe only changes in this release.
+ 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
diff --git a/scripts/installtests/build_release_assets_test.go b/scripts/installtests/build_release_assets_test.go
index 18ba9f9924..f56261ac3a 100644
--- a/scripts/installtests/build_release_assets_test.go
+++ b/scripts/installtests/build_release_assets_test.go
@@ -4955,6 +4955,7 @@ func TestReleaseNotesGeneratorResolvesChannelSpecificComparisonRanges(t *testing
"Use no semicolon or em dash characters",
"Name the specific feature or fix and where users find it",
"Never a theme or benefit slogan",
+ "Describe only changes in this release",
"- **[Short outcome]** - [Where users notice it and why it matters.]",
"requesting one constrained revision",
} {