Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Mention Flux upgrade guide in release notes #5073

Merged
merged 1 commit into from
Nov 14, 2024
Merged

docs: Mention Flux upgrade guide in release notes #5073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/release/release-notes-template.md
View file
Open in desktop
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).