📖 Add release templates #9572
📖 Add release templates #9572
Conversation
k8s-ci-robot
added
area/release
|
@kubernetes-sigs/cluster-api-release-team |
| @@ -0,0 +1,63 @@ | |||
| # Release Templates | |||
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Sure, linked to this page here: ebfcf48#diff-751bae1afb6862debc4d8d6b2d39bba9d2838e720c37c8b2805138c738843025R381
willie-yao
force-pushed
the
release-templates
branch
from
d7f4457
to
ebfcf48
Compare
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
@killianmuldoon created #9590 to improve the list below you suggested, PTAL
| ## Slack Weekly Announcement Template | ||
|
|
||
| ``` | ||
| # Weekly announcement template |
There was a problem hiding this comment.
Is this superseded by #9343?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
This is great!
Could you add a brief description on how/when to use each template?
Like for example:
- email: send an email to address blablbla. You'll need your email address authorized by whoever...
- weekly: send this in the #cluster-api slack channel every Monday blabl
willie-yao
force-pushed
the
release-templates
branch
from
ebfcf48
to
1669719
Compare
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 5754edf9c018fba86b4c7ca6eba135753136d47d
|
| ## Slack Weekly Announcement Template | ||
|
|
||
| ``` | ||
| # Weekly announcement template |
There was a problem hiding this comment.
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.
k8s-ci-robot
added
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: killianmuldoon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
I am happy to merge it as well, (it has already lgtm from Comms team Lead), so merging it. /unhold |
k8s-ci-robot
removed
the
do-not-merge/hold
What this PR does / why we need it:
This PR adds release templates to the docs/release directory
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #
/area release