summaryrefslogtreecommitdiff
path: root/making-release-notes.md
diff options
context:
space:
mode:
authorMarek Biskup <biskup@google.com>2015-06-19 17:41:12 +0200
committerMarek Biskup <biskup@google.com>2015-06-19 17:46:30 +0200
commitdab63f2280e28641cc0b0890c919106059243cbf (patch)
treea9dc6b8f7abccfb574d84653a30ebc83be26458b /making-release-notes.md
parent376edcfb1d576429f992d0cdce463e86b939e2c1 (diff)
add links to unlinked documents; move making-release-notes.md to docs/devel
Diffstat (limited to 'making-release-notes.md')
-rw-r--r--making-release-notes.md33
1 files changed, 33 insertions, 0 deletions
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.
+
+
+
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/making-release-notes.md?pixel)]()