Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2.5 KB

making-release-notes.md

File metadata and controls

77 lines (51 loc) · 2.5 KB
Raw

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/devel/making-release-notes.md).

Documentation for other releases can be found at releases.k8s.io.

Making release notes

This documents the process for making release notes for a release.

1) Note the PR number of the previous release

Find the most-recent PR that was merged with the previous .0 release. Remember this as $LASTPR. TODO: Figure out a way to record this somewhere to save the next release engineer time.

Find the most-recent PR that was merged with the current .0 release. Remember this as $CURRENTPR.

2) Run the release-notes tool

${KUBERNETES_ROOT}/build/make-release-notes.sh $LASTPR $CURRENTPR

3) Trim the release notes

This generates a list of the entire set of PRs merged since the last minor release. It is likely long and many PRs aren't worth mentioning. If any of the PRs were cherrypicked into patches on the last minor release, you should exclude them from the current release's notes.

Open up candidate-notes.md in your favorite editor.

Remove, regroup, organize to your hearts content.

4) Update CHANGELOG.md

With the final markdown all set, cut and paste it to the top of CHANGELOG.md

5) Update the Release page

  • Switch to the releases page.
  • Open up the release you are working on.
  • Cut and paste the final markdown from above into the release notes
  • Press Save.

Analytics