Project

General

Profile

Actions
History

HOWTO »

HOWTO write the release notes » History » Revision 8

« Previous | Revision 8/58 (diff) | Next »
Loïc Dachary, 07/14/2015 12:34 PM

  • git clone -b release (for instance git clone -b dumpling http://github.com/ceph/ceph)
  • run the following to get a base to work on
    git clone https://github.com/ceph/ceph
cd ceph/src/script/
pip install githubpy GitPython
GITHUB_ACCESS_TOKEN=55a0fc5dd745e4b338f33e616d6fec2ee ceph-release-notes -r tags/v0.80.9..tags/v0.80.10 $(git rev-parse --show-toplevel)
  • manual edit the list of commits
  • 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
  • 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.
  • add the release to the timeline
  • 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.

Updated by Loïc Dachary almost 9 years ago · 8 revisions