Skip to content

Commit

Permalink
Merge pull request #5073 from mloskot/patch-1
Browse files Browse the repository at this point in the history
docs: Mention Flux upgrade guide in release notes
  • Loading branch information
stefanprodan authored Nov 14, 2024
2 parents 5b83111 + 995e1dc commit 9f854cb
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/release/release-notes-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ The following template can be used for the GitHub release page:
<!-- auto-generated list of pull requests to the CLI starts here -->
```

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
Expand All @@ -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).
channel](https://cloud-native.slack.com/archives/CLAJ40HV3).

0 comments on commit 9f854cb

Please sign in to comment.