HOWTO write the release notes » History » Version 42
David Galloway, 06/30/2021 03:54 PM
1 | 42 | David Galloway | h1. Release Notes Prerequisites |
---|---|---|---|
2 | * Obtain a github API token and write it to <code>~/.github_token</code> on your workstation |
||
3 | |||
4 | 22 | David Galloway | h1. ceph.git Release Notes |
5 | |||
6 | 33 | David Galloway | *NOTE:* This will not work for hotfix releases because hotfixes usually don't have a PR. We backup the original branch, reset the branch to the previous point release, then manually commit the hotfix. You'll need to do the following process manually in these cases. grep the release notes files for 'hotfix' |
7 | |||
8 | 13 | Loïc Dachary | * git clone http://github.com/ceph/ceph (or git fetch to get the latest stable branch updates). Do *not* checkout the release branch as it does not have the *ceph-release-notes* script |
9 | * run the following: |
||
10 | 5 | Loïc Dachary | <pre> |
11 | 38 | David Galloway | # IF NEEDED |
12 | git fetch origin nautilus:nautilus |
||
13 | git fetch origin octopus:octopus |
||
14 | git fetch origin pacific:pacific |
||
15 | 31 | David Galloway | cd src/script |
16 | 20 | Nathan Cutler | virtualenv v |
17 | 1 | Loïc Dachary | source v/bin/activate |
18 | 33 | David Galloway | pip3 install githubpy GitPython review requests |
19 | 22 | David Galloway | # Replace 15.2.8 with whatever the previous stable release was |
20 | 1 | Loïc Dachary | # Replace 'octopus' with whatever release you're working on |
21 | 22 | David Galloway | # Replace XXXXX with your GitHub API token |
22 | 33 | David Galloway | python3 ./ceph-release-notes -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX |
23 | 9 | Loïc Dachary | deactivate |
24 | 1 | Loïc Dachary | </pre> |
25 | 29 | David Galloway | * Create a new branch either in your own fork of ceph.git or the actual ceph.git (but be careful and tidy!) |
26 | 22 | David Galloway | * Edit <code>doc/releases/RELEASE.rst</code> |
27 | 1 | Loïc Dachary | <pre> |
28 | 22 | David Galloway | vXX.X.X Branch |
29 | ============== |
||
30 | |||
31 | This is the Xth backport release in the RELEASE series. !! If there is a major change, it should be mentioned here. Ask sage, josh, and neha !! |
||
32 | We recommend all users update to this release. |
||
33 | |||
34 | Notable Changes |
||
35 | 1 | Loïc Dachary | --------------- |
36 | 22 | David Galloway | |
37 | * Copy them from here: https://github.com/ceph/ceph/blob/octopus/PendingReleaseNotes |
||
38 | 1 | Loïc Dachary | |
39 | Changelog |
||
40 | --------- |
||
41 | 22 | David Galloway | |
42 | 29 | David Galloway | * The bullet points output by <code>ceph-release-notes</code> should go here |
43 | 1 | Loïc Dachary | </pre> |
44 | * create a pull request with this change and request reviews from: neha-ojha, batrick, jdurgin, liewegas, cbodley, sebastian-philipp, gregsfortytwo |
||
45 | 40 | David Galloway | * In another PR targeting master, add the release to <code>doc/releases/index.rst</code> *AND* <code>doc/releases/releases.yml</code>. |
46 | 29 | David Galloway | |
47 | h3. Release Notes gotchas |
||
48 | |||
49 | * The *ceph-release-notes* script requires that each pull request is prefixed with the component it relates to (mon, osd etc.). If that's not the case, it will display an error message such as |
||
50 | 22 | David Galloway | <pre> |
51 | 29 | David Galloway | ERROR: http://github.com/ceph/ceph/pull/4884 title Keystone PKI token expiration is not enforced does not match ^(?:hammer|infernalis|jewel|kraken): (cli|common|mon|osd|fs|librbd|rbd|fs|mds|objecter|rgw|build/ops|tests|tools|cmake|doc|crush|librados)(:.*) |
52 | 26 | David Galloway | </pre> |
53 | 29 | David Galloway | the pull request title must be edited to add the required prefix. |
54 | 41 | Yuri Weinstein | * To run the script with githib token in ~/.github_token use *_--token $(cat ~/.github_token)_* |
55 | 22 | David Galloway | |
56 | h1. E-mail Release Notes |
||
57 | |||
58 | <pre> |
||
59 | To: ceph-announce@ceph.io, ceph-users@ceph.io, dev@ceph.io, ceph-maintainers@ceph.io |
||
60 | |||
61 | Title: vXX.X.X RELEASE released |
||
62 | |||
63 | Body: |
||
64 | We're happy to announce the Xth backport release in the RELEASE series. !! If there is a major change, it should be mentioned here. Ask sage, josh, and neha !! We recommend users to update to this release. For a detailed release notes with links & changelog please refer to the official blog entry at https://ceph.io/releases/vXX-X-X-RELEASE-released |
||
65 | |||
66 | Notable Changes |
||
67 | --------------- |
||
68 | |||
69 | * Copy bullet points from doc/releases/RELEASE.rst |
||
70 | |||
71 | Getting Ceph |
||
72 | ------------ |
||
73 | * Git at git://github.com/ceph/ceph.git |
||
74 | 39 | David Galloway | * Tarball at https://download.ceph.com/tarballs/ceph-XX.X.X.tar.gz |
75 | 37 | David Galloway | * For packages, see https://docs.ceph.com/docs/master/install/get-packages/ |
76 | 22 | David Galloway | * Release git sha1: $SHA1 |
77 | </pre> |
||
78 | |||
79 | h1. Website Release Notes |
||
80 | |||
81 | These instructions are for the Wordpress site. These will change when the new site is launched in 2021 (?). |
||
82 | |||
83 | * Log in to the Wordpress Admin panel |
||
84 | * Go to https://ceph.io/wp-admin/edit.php |
||
85 | * Mouse over a recent "released" blog post and click *Clone* |
||
86 | * Click *Edit* on the new cloned draft |
||
87 | * Using the same script, |
||
88 | <pre> |
||
89 | 24 | David Galloway | ./ceph-release-notes --html -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX |
90 | </pre> |
||
91 | 22 | David Galloway | * Update the backport release # and RELEASE name if needed |
92 | * Copy the notable changes from your e-mail |
||
93 | 28 | David Galloway | * Copy the output of <code>ceph-release-notes --html</code> under *Changelog* between the <code><u></u></code> tags. You may need to click *Edit as HTML* |
94 | * Be sure to update the URL slug on the right toolbar |