Skip to content

Commit 610d6c6

Browse files
committed
Add exceptions.yaml file format example to enhancements handbook
1 parent 144cdc7 commit 610d6c6

File tree

1 file changed

+45
-0
lines changed
  • release-team/role-handbooks/enhancements

1 file changed

+45
-0
lines changed

release-team/role-handbooks/enhancements/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -698,6 +698,51 @@ If there is continued unresponsiveness on issues, remove them from the milestone
698698

699699
Exception process is outlined [here](https://github.com/kubernetes/sig-release/blob/master/releases/EXCEPTIONS.md)
700700

701+
#### Exceptions.yaml File Format
702+
703+
When tracking exceptions for a release, create an `exceptions.yaml` file in the release directory (e.g., `releases/release-1.35/exceptions.yaml`). Here's the expected format:
704+
705+
```yaml
706+
# Exception requests in v1.35
707+
# Google Group: https://groups.google.com/g/kubernetes-sig-release
708+
# Release Team Lead: [Name] ([@github-handle](https://github.com/github-handle))
709+
710+
# Enhancements Freeze Exceptions requested in v1.35
711+
712+
enhancementFreeze:
713+
714+
- name: "Feature Name"
715+
issue: 1234
716+
date_requested: 2025-01-15
717+
date_reviewed: 2025-01-18
718+
thread: https://groups.google.com/g/kubernetes-sig-release/c/thread-id
719+
pull_requests:
720+
- https://github.com/kubernetes/enhancements/pull/5678
721+
status: "approved" # or "rejected"
722+
723+
# Code Freeze Exceptions requested in v1.35
724+
725+
codeFreeze:
726+
727+
- name: "Another Feature Name"
728+
issue: 5678
729+
date_requested: 2025-02-15
730+
date_reviewed: 2025-02-18
731+
thread: https://groups.google.com/g/kubernetes-sig-release/c/thread-id
732+
pull_requests:
733+
- https://github.com/kubernetes/kubernetes/pull/123456
734+
status: "approved" # or "rejected"
735+
```
736+
737+
**Field Descriptions:**
738+
- `name`: Human-readable name of the enhancement
739+
- `issue`: Enhancement issue number in kubernetes/enhancements
740+
- `date_requested`: Date when the exception was requested (YYYY-MM-DD format)
741+
- `date_reviewed`: Date when the exception was formally approved/rejected by the release team (YYYY-MM-DD format)
742+
- `thread`: Link to the Google Groups discussion thread
743+
- `pull_requests`: List of relevant PRs (enhancements PRs for enhancement freeze, k/k PRs for code freeze)
744+
- `status`: Either "approved" or "rejected"
745+
701746
### CNCF / Media Engagement
702747

703748
- You may be called upon by the communications lead to help with media engagement near the end of the release cycle. Please ensure that if there are any restrictions or training required by your company before engaging that you have completed those ahead of Code Thaw.

0 commit comments

Comments
 (0)