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

📖 Add release templates #9572

Merged
merged 1 commit into from
Oct 23, 2023
Merged

📖 Add release templates #9572

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions docs/release/release-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also improve the lists below - L387 -> L404 as part of this? Would be good to remove the TBD and get a specific list of all the communication channels, information and stakeholders.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@killianmuldoon checking this again, I see we have a separate/dedicated task in #9104 which is:

"Define details of "Communicate key dates to the community""

where this suggestion is referring to I believe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@killianmuldoon created #9590 to improve the list below you suggested, PTAL

Expand Down
69 changes: 69 additions & 0 deletions docs/release/release-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Release Templates
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we refer to this document from release tasks document, specifically from https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/release/release-tasks.md#continuously-communicate-key-dates-to-the-community?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, linked to this page here: ebfcf48#diff-751bae1afb6862debc4d8d6b2d39bba9d2838e720c37c8b2805138c738843025R381


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 `[email protected]` 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this superseded by #9343?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes although would it still be worth keeping around if someone wants to reference it? I don't see why anyone would need to though so I can go ahead and remove it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably leave it as a reference, since someone new in the team to the tool and never used it before to generate weekly announcements that will be introduced in #9343, has an idea of how it looks like beforehand.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just think it's going to be a lot of effort to keep it in sync vs just running the tool. Maybe the compromise is to have the templates for the notes tool be templates somewhere instead of being inlined in the go code?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add a line specifying that you can generate this template automatically with the notes tool. It might take some significant refactoring to have the generator to use it. Should I work on it now or defer it to a separate issue?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine to keep it for now IMO if the team is happy with it - would be good to move to templating over time as it probably makes the whole process easier to change and adapt.


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