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

docs: add notification step to release guide #607

Merged
merged 1 commit into from
Jul 22, 2024
Merged

docs: add notification step to release guide #607

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
18 changes: 17 additions & 1 deletion docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ This will trigger a [release GitHub action](https://github.com/rancher/turtles/a

**Note:** If you are cutting a new minor/major release, please follow the [next step](#post-release-steps-in-rancher-turtles-docs) below, otherwise skip.

## Announcing a release

When the new release is available, we need to notify a list of Slack channels so users and relevant stakeholders can stay up to date with the latest version and changes:
- SUSE Software Solutions `discuss-rancher-cluster-api`
- SUSE Software Solutions `team-engs-on-rancher-manager`
- Rancher Users `cluster-api`

You can use the following notification template and adapt it to the specifics of the release you are announcing:

```
Hi all! We are happy to announce a new release of Rancher Turtles - vx.x.x! With this release we <one line summary of the release>:
- list of relevant features/fixes
- ...
Please, take a look at the release notes <here link to GitHub release notes>.
```

## Post-release steps in Rancher Turtles Docs

If a new minor/major branch was created, there are some post-release actions that need to be taken.
Expand Down Expand Up @@ -130,4 +146,4 @@ The `release-X` branches contain stable, backwards compatible code. On every maj
Rancher Turtles maintains the most recent release/releases for all supported APIs. Support for this section refers to the ability to backport and release patch versions; [backport policy](#backporting) is defined above.

- The API version is determined from the GroupVersion defined in the top-level `api/` package.
- For the current stable API version (v1alpha1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
- For the current stable API version (v1alpha1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.