Skip to content

Commit

Permalink
docs: add notification step to release guide
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Salas <carlos.salas@suse.com>
  • Loading branch information
salasberryfin committed Jul 18, 2024
1 parent 0fbf6d0 commit 19bfc4a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/release.md
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.

0 comments on commit 19bfc4a

Please sign in to comment.