From 995e1dcc32c21c319b759010c13433e5434e58e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=81oskot?= Date: Wed, 13 Nov 2024 14:39:41 +0100 Subject: [PATCH] docs: Mention Flux upgrade guide in release notes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/fluxcd/flux2/discussions/5072 Signed-off-by: Mateusz Łoskot --- docs/release/release-notes-template.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/release/release-notes-template.md b/docs/release/release-notes-template.md index 0b3a41deaa..2a05d5c544 100644 --- a/docs/release/release-notes-template.md +++ b/docs/release/release-notes-template.md @@ -43,6 +43,9 @@ The following template can be used for the GitHub release page: ``` +Typically, you want to link the [Flux upgrade](https://fluxcd.io/flux/installation/upgrade/) +guide to refer users for up to date information on upgrade options. + In some scenarios, you may want to include specific information about API changes and/or upgrade procedures. Consult [the formatting of `v2.0.0-rc.1`](https://github.com/fluxcd/flux2/releases/tag/v2.0.0-rc.1) for @@ -69,4 +72,4 @@ The following template can be used for the Slack release message: ``` For more concrete examples, see the pinned messages in the [Flux Slack -channel](https://cloud-native.slack.com/archives/CLAJ40HV3). \ No newline at end of file +channel](https://cloud-native.slack.com/archives/CLAJ40HV3).