Skip to content

Commit fb69955

Browse files
authored
Merge pull request #4004 from onyiny-ang/patch-1
Updating Release Notes Document
2 parents 6afa05a + 2fd4334 commit fb69955

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

contributors/guide/release-notes.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,17 @@ slug: "release-notes"
55
---
66

77
On the kubernetes/kubernetes repository, release notes are required for any pull
8-
request with user-visible changes, such as bug fixes, feature additions, and
9-
output format changes. Release notes are one of the most important reference
8+
request with user-visible changes, this could mean:
9+
10+
##### - User facing, critical bug-fixes
11+
##### - Notable feature additions
12+
##### - Output format changes
13+
##### - Deprecations or removals
14+
##### - Metrics changes
15+
##### - Dependency changes
16+
##### - API changes
17+
18+
Release notes are one of the most important reference
1019
points for users about to install or upgrade to a particular release of
1120
Kubernetes.
1221

@@ -45,6 +54,10 @@ A release note needs a clear, concise description of the change. This includes:
4554
4. a link to relevant user documentation about the enhancement/feature
4655

4756
## Applying a Release Note
57+
slug: "adding-release-notes"
58+
59+
On the kubernetes/kubernetes repository, release notes are required for any pull request with [user-visible changes](#--user-facing-critical-bug-fixes).
60+
4861

4962
To meet this requirement, do one of the following:
5063
- Add notes in the release notes block, or
@@ -72,7 +85,21 @@ For pull requests that don't need to be mentioned at release time, use the `/rel
7285
NONE
7386
```
7487

75-
To see how to format your release notes, view the kubernetes/kubernetes [pull request template](https://git.k8s.io/kubernetes/.github/PULL_REQUEST_TEMPLATE.md) for a brief example. Pull Request titles and body comments can be modified at any time prior to the release to make them friendly for release notes.
88+
Your release note should be written in clear and straightforward sentences. Most often, users aren't familiar with the technical details of your PR, so consider what they _need to know_ when you write your release note.
89+
90+
Some brief examples of release notes:
91+
92+
```
93+
The deprecated flag --conntrack-max has been removed from kube-proxy. Users of this flag should switch to --conntrack-min and --conntrack-max-per-core instead. (#78399, @rikatz)
94+
95+
The --export flag for the kubectl get command, deprecated since v1.14, will be removed in v1.18.
96+
97+
Fixed a bug that prevents dry-run from being honored for the pod/eviction sub-resource. (#76969, @apelisse)
98+
```
99+
100+
Pull Request titles and body comments can be modified at any time prior to the release to make them friendly for release notes.
101+
102+
The release notes team maintains a [template](https://github.com/kubernetes/sig-release/blob/master/release-team/role-handbooks/release-notes/relnotes-template.md) for Kubernetes Release notes that may help clarify whether or not your PR requires a release note. The most recent [Kubernetes Release notes](https://kubernetes.io/docs/setup/release/notes/) can also provide insight into the writing style for release notes.
76103

77104
Release notes apply to pull requests on the master branch. For patch release branches the automated cherry-pick pull requests process (see the [cherry-pick instructions](/contributors/devel/sig-release/cherry-picks.md)) should be followed. That automation will pull release notes from the master branch PR from which the cherry-pick originated. On a rare occasion a pull request on a patch release branch is not a cherry-pick, but rather is targeted directly to the non-master branch and in this case, a `release-note-*` label is required for that non-master pull request.
78105

0 commit comments

Comments
 (0)