Skip to content

Improve Enhancements Role Handbook with test freeze, PRR process, and… #2894

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve Enhancements Role Handbook with test freeze, PRR process, and… #2894

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
77 changes: 77 additions & 0 deletions release-team/role-handbooks/enhancements/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,31 @@ Please contact SIG Release on Slack if there is any uncertainty regarding whethe
- Provide updates during release team meetings
- Use the `KEPs by Stage` insight from the Enhancement Tracking Board ([example](https://github.com/orgs/kubernetes/projects/98/insights/3))
- Notify folks in [#prod-readiness](https://kubernetes.slack.com/archives/CPNHUMN74) about KEPs waiting for PRR reviews with the project board filtered for KEPs missing PRR assignees.

**How to notify #prod-readiness about KEPs waiting for PRR reviews:**

1. **Filter the project board** to show KEPs missing PRR assignees:
- Go to the Enhancements Tracking Board
- Apply filters: `PRR Status` = "Not Started" or "In Progress"
- This will show KEPs that need PRR attention

2. **Timing**: Send notifications typically 1-2 weeks before enhancement freeze to give PRR team sufficient time to review

3. **Template message for #prod-readiness**:
```
Hi PRR team! 👋 {current release} Enhancements team here.

We're approaching enhancement freeze on **{ENHANCEMENTS_FREEZE_DATETIME}** and wanted to flag KEPs that may need PRR attention.

Here are KEPs currently waiting for PRR reviews: [Link to filtered project board view]

If any of these KEPs are missing PRR assignees or need expedited review, please let us know.
We can help coordinate with KEP authors if needed.

Thanks for your support! 🙏
```

4. **Follow up**: If KEPs remain without PRR assignees closer to enhancement freeze, send a reminder with specific KEP numbers that need attention

#### PRR Reviews

Expand Down Expand Up @@ -263,6 +288,26 @@ As described by the PRR team [here](https://groups.google.com/a/kubernetes.io/g/

> Note: KEPs that doesn't complete the PRR questionnaire and get back to the reviews from the PRR team are removed from the milestone during the enhancements freeze party. The PRR freeze deadline exists as a reminder for this.

##### PRR Freeze Review Process

As the PRR freeze approaches, the Enhancements team should systematically review all assigned KEPs on the tracking board. For each KEP, follow this process:

1. **Check PRR Freeze Requirements**:
- The KEP is in the current Release Milestone (e.g., v1.35)
- The KEP has the `lead-opted-in` label applied
- A PR is open or merged with the KEP's PRR questionnaire filled out
- A PR is open or merged with `kep.yaml` updated with the `stage`, `latest-milestone`, and `milestone` struct filled out
- A PR is open or merged with a PRR approval file with the PRR approver mentioned for the stage the KEP is targeting

2. **Post GitHub Comments**: For each assigned KEP, post a GitHub comment using the appropriate template (see [PRR Freeze Templates](#prr-freeze-templates) below) reminding them of the PRR Freeze deadline and mentioning the status of the KEP.

3. **Update Board Status**: Update the status on the tracking board to either:
- `At risk for PRR freeze` - if the KEP does not meet the criteria
- `Tracked for PRR freeze` - if the KEP meets all criteria
- `Removed from Milestone` - if the KEP fails to meet PRR freeze requirements and is removed from the release

4. **Follow Up**: Monitor KEPs marked as "At risk" and provide additional support or guidance as needed.

##### Enhancement KEP Status

For each Enhancement KEP, the Enhancement team needs to verify that the `status` set in the KEP is one of `provisional`, `implementable`, `implemented`, `deferred`, `rejected`, `withdrawn`, or `replaced`.
Expand Down Expand Up @@ -334,6 +379,20 @@ To avoid delays and ensure everything is in place for Code Freeze:

Read https://github.com/kubernetes/sig-release/blob/master/releases/release_phases.md#code-freeze for more information on the Code Freeze.

#### Understanding Test Freeze

Test freeze occurs simultaneously with [Code Freeze](https://github.com/kubernetes/sig-release/blob/master/releases/release_phases.md#test-freeze). For the Enhancements team, this means:

- **What it means**: No new tests may be changed or promoted to Conformance unless there are release-blocking or other exceptional reasons
- **For enhancements**: All test PRs related to tracked enhancements must be in a merge-ready state (with `approved` and `lgtm` labels) by the test freeze deadline
- **Verification steps**:
- Ensure all test PRs for tracked enhancements are linked in the enhancement issue description
- Verify test PRs have the required labels (`approved` and `lgtm`) applied
- Check that test PRs are either merged or ready to merge by the deadline
- **Relationship to Code Freeze**: Both code freeze and test freeze requirements must be satisfied for an enhancement to be considered "Tracked for code freeze"

> **Note**: The test freeze deadline is the same as code freeze. When checking enhancement readiness, verify both code and test PRs meet the merge-ready criteria.

#### Pre-Freeze Check: Catching untracked feature changes

As part of the Enhancements team’s responsibilities, this step helps ensure that user-facing feature changes are not merged without being properly tracked via a KEP.
Expand Down Expand Up @@ -496,6 +555,24 @@ With all the PRR freeze requirements in place, this enhancement is now marked as

Then make sure the status of the enhancement is set to `Tracked for PRR freeze`.

If the Enhancement Issue **fails to meet PRR freeze requirements** and is removed from the milestone, use this template in Issue comments:

```markdown
Hello {enhancement owner} 👋, {current release} Enhancements team here.

Unfortunately, this enhancement did not meet the requirements for [PRR freeze](https://github.com/kubernetes/sig-release/blob/master/releases/release_phases.md#prr-freeze) and has been removed from the {current release} milestone.

The following PRR freeze requirements were not met:
- {list specific missing requirements}

If you still wish to progress this enhancement in {current release}, please file an [exception request](https://github.com/kubernetes/sig-release/blob/master/releases/EXCEPTIONS.md) as soon as possible, within three days. If you have any questions, you can reach out in the #release-enhancements channel on Slack and we'll be happy to help. Thanks!

/label tracked/no
/milestone clear
```

Then make sure the status of the enhancement is set to `Removed from Milestone`.

#### Enhancement Freeze Templates

If the Enhancement Issue **does not** meet the criteria for inclusion in the current release use this template in Issue comments:
Expand Down