HOWTO announce a release » History » Version 14
Nathan Cutler, 07/23/2019 11:24 AM
1 | 8 | Nathan Cutler | h3. HOWTO announce a release |
---|---|---|---|
2 | 1 | Abhishek Lekshmanan | |
3 | 10 | Nathan Cutler | h4. Cut Packages |
4 | |||
5 | 1 | Abhishek Lekshmanan | * Alfredo announces to QA Lead, Project Lead & Release manager once the final packages are cut |
6 | 5 | Abhishek Lekshmanan | |
7 | 10 | Nathan Cutler | h4. Draft and Merge Release Notes PR |
8 | |||
9 | 6 | Nathan Cutler | * Release manager to create the release notes by submitting a patch to <code>doc/releases/<named_branch>.rst</code> as a PR targeting the *master* branch |
10 | 7 | Abhishek Lekshmanan | ** Release notes are generated using the script <code>src/script/ceph-release-notes</code> |
11 | 1 | Abhishek Lekshmanan | ** Make manual corrections to components as much as possible in the release notes for easier tracking. |
12 | |||
13 | 10 | Nathan Cutler | h4. Blog Post |
14 | 1 | Abhishek Lekshmanan | |
15 | 10 | Nathan Cutler | * Once the PR with the patch to <code>doc/releases/<named_branch>.rst</code> is merged, and the right urls are checked, do a blog post on ceph.com with the correct links. Procedure: |
16 | ** In the PR, issue "jenkins render docs" command to get a HTML render of the release notes. |
||
17 | ** Login to WordPress management interface for the ceph.com blog -> https://ceph.com/wp-login.php |
||
18 | ** In WordPress, start a new Post, and go into "Code Editor" (note: the "Code Editor" is very well hidden - it is accessed by clicking on a vertical row of three small dots at the extreme upper right - just under the place where WordPress says "Howdy" to you) |
||
19 | ** In the browser tab where you are browsing the rendered release notes, click on "Releases" and navigate to the new release. Tell the browser to display the page source. Copy-paste the HTML source code of the release notes into the WordPress Code Editor. |
||
20 | ** Change the "Category" of the post from "Community" to "Release", and optionally add a "release" tag as well. |
||
21 | ** Save the blog post as a draft, and possibly ask others to review it prior to publishing |
||
22 | ** Once the packages are cut and the PR with the release notes is approved and merged, click the "Publish" button in WordPress to publish the blog post. The URL should look like this: https://ceph.com/releases/v14-2-2-nautilus-released/ |
||
23 | 1 | Abhishek Lekshmanan | |
24 | 10 | Nathan Cutler | h4. Email to mailing lists |
25 | |||
26 | * Make a text-only version of the release notes, based on the merged release notes PR and omitting the Changelog (unless it is just a few lines). Instead of the full Changelog, the email can say, e.g.: "For a detailed changelog please refer to the official release notes entry at the Ceph blog: https://ceph.com/releases/v14-2-1-nautilus-released/" |
||
27 | 12 | Nathan Cutler | * At the end of the email, include a section that says: |
28 | |||
29 | <pre> |
||
30 | Getting Ceph |
||
31 | ------------ |
||
32 | |||
33 | * Git at git://github.com/ceph/ceph.git |
||
34 | * Tarball at http://download.ceph.com/tarballs/ceph-14.2.1.tar.gz |
||
35 | 13 | Nathan Cutler | * For packages, see http://docs.ceph.com/docs/master/install/get-packages/ |
36 | 12 | Nathan Cutler | * Release git sha1: d555a9489eb35f84f2e1ef49b77e19da9d113972 |
37 | 1 | Abhishek Lekshmanan | </pre> |
38 | 12 | Nathan Cutler | |
39 | 13 | Nathan Cutler | * Sample (v14.2.1) announcement email: https://www.spinics.net/lists/ceph-devel/msg45338.html |
40 | 14 | Nathan Cutler | * Send out the email to the following mailing lists: |
41 | 10 | Nathan Cutler | ** ceph-announce@ceph.com |
42 | ** ceph-maintainers@ceph.com |
||
43 | ** ceph-users@ceph.com |
||
44 | ** dev@ceph.io |
||
45 | ** ceph-devel@vger.kernel.org |
||
46 | |||
47 | 11 | Nathan Cutler | h4. Tweet |
48 | |||
49 | 10 | Nathan Cutler | * Inform the Ceph Community Manager about the release so that @ceph tweets the release |