HOWTO write the release notes » History » Revision 31
Revision 30 (David Galloway, 03/11/2021 08:54 PM) → Revision 31/58 (David Galloway, 03/30/2021 04:17 PM)
h1. ceph.git Release Notes * 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 * run the following: <pre> cd src/script ceph/src/script virtualenv v source v/bin/activate pip install githubpy GitPython review requests # Replace 15.2.8 with whatever the previous stable release was # Replace 'octopus' with whatever release you're working on # Replace XXXXX with your GitHub API token ./ceph-release-notes -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX deactivate </pre> * Create a new branch either in your own fork of ceph.git or the actual ceph.git (but be careful and tidy!) * Edit <code>doc/releases/RELEASE.rst</code> <pre> vXX.X.X Branch ============== 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 !! We recommend all users update to this release. Notable Changes --------------- * Copy them from here: https://github.com/ceph/ceph/blob/octopus/PendingReleaseNotes Changelog --------- * The bullet points output by <code>ceph-release-notes</code> should go here </pre> * create a pull request with this change and request reviews from: neha-ojha, batrick, jdurgin, liewegas, dillaman, cbodley, sebastian-philipp h3. Release Notes gotchas * 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 <pre> 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)(:.*) </pre> the pull request title must be edited to add the required prefix. h1. E-mail Release Notes <pre> To: ceph-announce@ceph.io, ceph-users@ceph.io, dev@ceph.io, ceph-maintainers@ceph.io Title: vXX.X.X RELEASE released Body: 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 Notable Changes --------------- * Copy bullet points from doc/releases/RELEASE.rst Getting Ceph ------------ * Git at git://github.com/ceph/ceph.git * Tarball at http://download.ceph.com/tarballs/ceph-XX.X.X.tar.gz * For packages, see http://docs.ceph.com/docs/master/install/get-packages/ * Release git sha1: $SHA1 </pre> h1. Website Release Notes These instructions are for the Wordpress site. These will change when the new site is launched in 2021 (?). * Log in to the Wordpress Admin panel * Go to https://ceph.io/wp-admin/edit.php * Mouse over a recent "released" blog post and click *Clone* * Click *Edit* on the new cloned draft * Using the same script, <pre> ./ceph-release-notes --html -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX </pre> * Due to dgalloway's limited python skills, this will output each line as <code><li><p>octopus: mds: etc.</code>. * Paste the output into a file, open it in <code>vim</code> and delete the <code>release:</code> column. e.g., <pre> - <li><p>octopus: mds: etc. - <li><p>octopus: mds: etc. + <li><p>mds: etc. + <li><p>mds: etc. </pre> * Update the backport release # and RELEASE name if needed * Copy the notable changes from your e-mail * 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* * Be sure to update the URL slug on the right toolbar