|
| 1 | +# Release Templates |
| 2 | + |
| 3 | +This document contains a collection of announcement templates for the release team. |
| 4 | + |
| 5 | +## Email Release Announcement Template |
| 6 | + |
| 7 | +To use this template, send an email using the following template to the `[email protected]` mailing list. The person sending out the email should ensure that they are first part of the mailing list. |
| 8 | + |
| 9 | +``` |
| 10 | +Hello everyone, |
| 11 | +
|
| 12 | +Cluster API patch version vX.Y.Z has been released! |
| 13 | +
|
| 14 | +This release was focused on improving existing features and stability of CAPI. |
| 15 | +There were a total of A commits and B bugs fixed by our awesome contributors! Kudos! |
| 16 | +
|
| 17 | +Below is the release note of the vX.Y.Z patch release: |
| 18 | +- https://github.com/kubernetes-sigs/cluster-api/releases/tag/vX.Y.Z |
| 19 | +
|
| 20 | +Thanks to all our contributors! |
| 21 | +
|
| 22 | +Best, |
| 23 | +CAPI Release Team |
| 24 | +``` |
| 25 | + |
| 26 | +## Slack Weekly Announcement Template |
| 27 | + |
| 28 | +Post the following template to the `#cluster-api` channel on the Kubernetes Slack under a thread. Make a separate post under the thread for the current release as well as the past two releases. |
| 29 | + |
| 30 | +``` |
| 31 | +# Weekly announcement template |
| 32 | +
|
| 33 | +Weekly update :rotating_light: |
| 34 | +Week `x` - `yyyy-mm-dd` to `yyyy-mm-dd` (If unsure what week check either Google Calendar or https://vecka.nu/) |
| 35 | +From your friendly comms release team |
| 36 | +
|
| 37 | +Fun stats :wookie_party_time: |
| 38 | +1. X PRs merged for all releases |
| 39 | +1. X PRs merged into 1.X (main) |
| 40 | +1. X bugs fixed |
| 41 | +
|
| 42 | +New Features |
| 43 | +- :sparkles: Some feature.. |
| 44 | +- For a full list of all the changes see last weeks closed PRs see : https://github.com/kubernetes-sigs/cluster-api/pulls?q=is%3Apr+closed%3AYYYY-MM-DD..YYYY-MM-DD+is%3Amerged+ |
| 45 | +
|
| 46 | +Important upcoming dates :spiral_calendar_pad: (OPTIONAL) |
| 47 | +- vX.X.0-beta.0 released - (Add date here) |
| 48 | +- release-X.X branch created (Begin [Code Freeze]) - (Add date here) |
| 49 | +- vX.X.0 released - (Add date here) |
| 50 | +``` |
| 51 | + |
| 52 | +## Slack Release Announcement Template |
| 53 | + |
| 54 | +Post the following template to the `#cluster-api` channel on the Kubernetes Slack for each release. |
| 55 | + |
| 56 | +``` |
| 57 | +# X.Y.Z Slack announcement example |
| 58 | +
|
| 59 | +:tada: :tada: :tada: |
| 60 | +
|
| 61 | +Cluster API vX.Y.Z has been released :cluster-api: |
| 62 | +
|
| 63 | +This release was focused on improving existing features and stability of CAPI. |
| 64 | +There were a total of A commits and B bugs fixed by our awesome contributors! Kudos! |
| 65 | +
|
| 66 | +**Some of the hightlights in this release are**: |
| 67 | +- :sparkles: Some feature.. |
| 68 | +
|
| 69 | +Full list of changes: https://github.com/kubernetes-sigs/cluster-api/releases/tag/vX.Y.Z |
0 commit comments