From fa345eb0d8bd00d0581103c3490c45a03e8958cd Mon Sep 17 00:00:00 2001 From: Prajyot-Parab Date: Tue, 22 Aug 2023 23:45:37 +0530 Subject: [PATCH] Documentation improvements: suggestions for team leads Signed-off-by: Prajyot-Parab --- docs/release/release-tasks.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md index 54b92a774ef0..3e10e954cee9 100644 --- a/docs/release/release-tasks.md +++ b/docs/release/release-tasks.md @@ -26,6 +26,7 @@ This document details the responsibilities and tasks for each role in the releas - [[Continuously] Maintain the GitHub release milestone](#continuously-maintain-the-github-release-milestone) - [[Continuously] Bump the Go version](#continuously-bump-the-go-version) - [[Repeatedly] Cut a release](#repeatedly-cut-a-release) + - [[Optional] Public release session](#optional-public-release-session) - [[Optional] [Track] Bump the Cluster API apiVersion](#optional-track-bump-the-cluster-api-apiversion) - [[Optional] [Track] Bump the Kubernetes version](#optional-track-bump-the-kubernetes-version) - [Communications/Docs/Release Notes Manager](#communicationsdocsrelease-notes-manager) @@ -50,6 +51,8 @@ This document details the responsibilities and tasks for each role in the releas - [Responsibilities](#responsibilities-3) - [Tasks](#tasks-3) - [[Repeatedly] Publish the release](#repeatedly-publish-the-release) +- [Suggestions for Team Leads](#suggestions-for-team-leads) + - [Time Commitments](#time-commitments) @@ -238,7 +241,7 @@ Additional information: * Create a release tag on the GitHub repository. * Create/update/publish GitHub releases. -[Optional] Public release session +#### [Optional] Public release session 1. Host a release session over a public zoom meeting. 2. Record the session for future reference and transparency. 3. Use release process-related waiting periods as a forum for discussing issues/questions. @@ -513,3 +516,28 @@ Publish the release. 1. The draft release should be automatically created via the [Create Release GitHub Action](https://github.com/kubernetes-sigs/cluster-api/actions/workflows/release.yml) with release notes previously committed to the repo by the release team. 2. Publish the release. Ensure release is flagged as `pre-release` for all `beta` and `rc` releases or `latest` for a new release in the most recent release branch. + +## Suggestions for Team Leads + * Clearly communicate with the team that the majority of the work during the release cycle will be a collaborative effort. + * Establish an ownership rotation policy in consultation with respective team members. + * Provide opportunities for team members to take the lead in cutting a release within the cycle, based on feasibility. + * Define backup ownership and tasks for team members, such as: + * Hosting community meetings. + * Communicating key updates during office hours meetings when necessary. + * Sharing release-related updates with the CAPI community. + * Monitoring and reporting CI status regularly to the release team. + * Scheduling additional meetings as required to facilitate a smooth release cycle. + +### Time Commitments +Here's a rough estimate of the time requirements per week: + + * Weeks 1-4: 4-8 hours a week + * Weeks 5-15: 6-12 hours a week + * Week after Code Freeze: Be prepared to dedicate a significant amount of time each day to release-related activities. + * Weeks 16-18: 8-16 hours a week + * Release Day: Prepare to spend the entire day on release-related activities. If the choice is between working after-hours or on weekends and having the release delayed beyond the initial target, delaying the release is preferred. + +Specific time commitments include: + * Release Team meetings once a week throughout the entire release cycle. + * Release Day meetings ideally occurring once during the actual release weeks (weeks 5, 9, 13-14, 16-18). + * Any other release-related critical meetings with prior notice.