diff options
| author | Marek Biskup <biskup@google.com> | 2015-06-19 17:41:12 +0200 |
|---|---|---|
| committer | Marek Biskup <biskup@google.com> | 2015-06-19 17:46:30 +0200 |
| commit | dab63f2280e28641cc0b0890c919106059243cbf (patch) | |
| tree | a9dc6b8f7abccfb574d84653a30ebc83be26458b | |
| parent | 376edcfb1d576429f992d0cdce463e86b939e2c1 (diff) | |
add links to unlinked documents; move making-release-notes.md to docs/devel
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | making-release-notes.md | 33 |
2 files changed, 35 insertions, 0 deletions
@@ -6,6 +6,8 @@ Docs in this directory relate to developing Kubernetes. * **Development Guide** ([development.md](development.md)): Setting up your environment tests. +* **Making release notes** ([making-release-notes.md](making-release-notes.md)): Generating release nodes for a new release. + * **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests. Here's how to run your tests many times. diff --git a/making-release-notes.md b/making-release-notes.md new file mode 100644 index 00000000..823bff64 --- /dev/null +++ b/making-release-notes.md @@ -0,0 +1,33 @@ +## 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 PR that was merged with the previous release. Remember this number +_TODO_: Figure out a way to record this somewhere to save the next release engineer time. + +### 2) Build the release-notes tool +```bash +${KUBERNETES_ROOT}/build/make-release-notes.sh <pr-number-from-1> +``` + +### 3) Trim the release notes +This generates a list of the entire set of PRs merged since the last release. It is likely long +and many PRs aren't worth mentioning. + +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](https://github.com/GoogleCloudPlatform/kubernetes/releases) page. + * Open up the release you are working on. + * Cut and paste the final markdown from above into the release notes + * Press Save. + + + +[]() |