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:
  

  cd 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
  

• 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
  

  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)(:.*)
  

  
  the pull request title must be edited to add the required prefix.
• add a section in http://docs.ceph.com/docs/master/release-notes/ in the master branch of ceph in the release-notes.rst file with the list of commits. The general idea is that the file on master reflects all releases ever published. The relevant part is then backported so that it also shows in the stable branch.
• Create a new branch
• Edit doc/releases/RELEASE.rst
  

  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 output of ceph-release-notes should go here
  

• create a pull request with this change and request reviews from all leads
  * add the text only version of the release notes as a comment to the pull request
  

  ./ceph-release-notes  -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX
  

  
  so that it can conveniently be copy/pasted when sending the mail announcing the release.
• backport the release notes to the release branch when they are final. Ideally this is done before the point release is published. If not it can be backported shortly afterwards.
• the release notes come with an introduction that is prepared in a separate file . It can be edited if something significant must not be forgotten and it does not need to well written because it is a draft.
• the content of the pending release notes file can be manually added at the beginning of the release-notes.rst. In theory the person writing the release notes should know about these pending notes so this is just a way to make sure they are not forgotten.

E-mail Release Notes¶

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

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,
  

  ./ceph-release-notes --html -r tags/v15.2.8..origin/octopus $(git rev-parse --show-toplevel) --token XXXXX
  

• Update the backport release # and RELEASE name if needed
• Copy the notable changes from your e-mail
• Copy the output of ceph-release-notes --html under Changelog