Project

General

Profile

HOWTO announce a release » History » Revision 10

Revision 9 (Nathan Cutler, 07/23/2019 11:11 AM) → Revision 10/15 (Nathan Cutler, 07/23/2019 11:22 AM)

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 http://docs.ceph.com/docs/master/release-notes/ updates with the patch to <code>doc/releases/<named_branch>.rst</code> is merged, above files, and the right urls are checked, do a blog post on ceph.com with the correct links. Procedure: 
 ** In links, this can be copy-pasted from the PR, issue "jenkins render docs" command to get a HTML render of the html rendered 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 - notes (alternatively just under the place where WordPress says "Howdy" ask jenkins to you) 
 ** In the browser tab where you are browsing the rendered release notes, click on "Releases" render docs via jenkins render docs and navigate to copy paste 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. related html 
 ** Change , also the "Category" of the post from "Community" to "Release", and optionally add a "release" tag as well. 
 ** Save the blog post can be saved as a draft, and possibly ask others to review it prior to publishing 
 ** Once draft in advance so that the publish button can be clicked once the packages are cut and out. 

 * Announce the PR email preferably 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/ 

 h4. Email to mailing lists 

 * Make a text-only plain text version of the release notes, based on use discretion if the merged release notes PR and omitting the Changelog (unless it changelog is large.. in that case just a few lines). Instead of link to the full Changelog, blog might suffice with the email can say, e.g.: "For a detailed changelog please refer to the official major release notes entry at announcements only in the Ceph blog: https://ceph.com/releases/v14-2-1-nautilus-released/" 
 * Send this as an email email. The mail needs 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 be sent to ceph-announce, ceph-users, ceph-maintainers, ceph-devel lists 

 * Inform the Ceph Community Manager Patrick (@scuttlemonkey) about the release so that @ceph tweets the release