From 1669719114e1cc36ec1b7458e4b9df5672310f82 Mon Sep 17 00:00:00 2001 From: willie-yao Date: Wed, 18 Oct 2023 19:22:40 +0000 Subject: [PATCH] Add release-templates.md --- docs/release/release-tasks.md | 2 + docs/release/release-templates.md | 69 +++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 docs/release/release-templates.md diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md index 8a7848ab0054..1ad7afaf18b1 100644 --- a/docs/release/release-tasks.md +++ b/docs/release/release-tasks.md @@ -378,6 +378,8 @@ done just remove the hold to merge it. The goal of this task is to ensure all stakeholders are informed about the current release cycle. For example announcing upcoming code freezes etc based on the [release timeline (1.4 example)](./releases/release-1.4.md). +Templates for all types of communication can be found in the [release-templates page](./release-templates.md). + Information can be distributed via: * `sig-cluster-lifecycle` mailing list diff --git a/docs/release/release-templates.md b/docs/release/release-templates.md new file mode 100644 index 000000000000..86d338346ebd --- /dev/null +++ b/docs/release/release-templates.md @@ -0,0 +1,69 @@ +# Release Templates + +This document contains a collection of announcement templates for the release team. + +## Email Release Announcement Template + +To use this template, send an email using the following template to the `kubernetes-sig-cluster-lifecycle@googlegroups.com` mailing list. The person sending out the email should ensure that they are first part of the mailing list. + +``` +Hello everyone, + +Cluster API patch version vX.Y.Z has been released! + +This release was focused on improving existing features and stability of CAPI. +There were a total of A commits and B bugs fixed by our awesome contributors! Kudos! + +Below is the release note of the vX.Y.Z patch release: +- https://github.com/kubernetes-sigs/cluster-api/releases/tag/vX.Y.Z + +Thanks to all our contributors! + +Best, +CAPI Release Team +``` + +## Slack Weekly Announcement Template + +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. + +``` +# Weekly announcement template + +Weekly update :rotating_light: +Week `x` - `yyyy-mm-dd` to `yyyy-mm-dd` (If unsure what week check either Google Calendar or https://vecka.nu/) +From your friendly comms release team + +Fun stats :wookie_party_time: +1. X PRs merged for all releases +1. X PRs merged into 1.X (main) +1. X bugs fixed + +New Features +- :sparkles: Some feature.. +- 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+ + +Important upcoming dates :spiral_calendar_pad: (OPTIONAL) +- vX.X.0-beta.0 released - (Add date here) +- release-X.X branch created (Begin [Code Freeze]) - (Add date here) +- vX.X.0 released - (Add date here) +``` + +## Slack Release Announcement Template + +Post the following template to the `#cluster-api` channel on the Kubernetes Slack for each release. + +``` +# X.Y.Z Slack announcement example + +:tada: :tada: :tada: + +Cluster API vX.Y.Z has been released :cluster-api: + +This release was focused on improving existing features and stability of CAPI. +There were a total of A commits and B bugs fixed by our awesome contributors! Kudos! + +**Some of the hightlights in this release are**: +- :sparkles: Some feature.. + +Full list of changes: https://github.com/kubernetes-sigs/cluster-api/releases/tag/vX.Y.Z