Ceph » Stable releases

h3. HOWTO announce a release

h4. Cut Packages

* Alfredo announces to QA Lead, Project Lead & Release manager once the final packages are cut

h4. Draft and Merge Release Notes PR

* 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 

** Release notes are generated using the script <code>src/script/ceph-release-notes</code>

** Make manual corrections to components as much as possible in the release notes for easier tracking.

h4. Blog Post

* 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:

** In the PR, issue "jenkins render docs" command to get a HTML render of the release notes.

** Login to WordPress management interface for the ceph.com blog -> https://ceph.com/wp-login.php

** 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)

** 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.

** Change the "Category" of the post from "Community" to "Release", and optionally add a "release" tag as well.

** Save the blog post as a draft, and possibly ask others to review it prior to publishing

** 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/

** Also update the "Latest Ceph" tarball link on https://ceph.io/get

h4. Email to mailing lists

* 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/"

* At the end of the email, include a section that says:

<pre>

Getting Ceph

------------

* Git at git://github.com/ceph/ceph.git

* Tarball at http://download.ceph.com/tarballs/ceph-14.2.1.tar.gz

* For packages, see http://docs.ceph.com/docs/master/install/get-packages/

* Release git sha1: d555a9489eb35f84f2e1ef49b77e19da9d113972

</pre>

* Sample (v14.2.1) announcement email: https://www.spinics.net/lists/ceph-devel/msg45338.html

* Send out the email to the following mailing lists:

** ceph-announce@ceph.com

** ceph-maintainers@ceph.com

** ceph-users@ceph.com

** dev@ceph.io

** ceph-devel@vger.kernel.org

h4. Tweet

* Inform the Ceph Community Manager about the release so that @ceph tweets the release