HOWTO write the release notes » History » Version 5
Loïc Dachary, 05/06/2015 02:54 PM
| 1 | 1 | Loïc Dachary | * git clone -b release (for instance git clone -b dumpling http://github.com/ceph/ceph) |
|---|---|---|---|
| 2 | * run the following to get a base to work on |
||
| 3 | <pre> |
||
| 4 | 5 | Loïc Dachary | git clone https://github.com/ceph/ceph |
| 5 | git clone https://github.com/theanalyst/ceph-release-helper |
||
| 6 | cd ceph-release-helper |
||
| 7 | virtualenv . |
||
| 8 | . bin/activate |
||
| 9 | pip install -r requirements.txt |
||
| 10 | python setup.py install |
||
| 11 | GITHUB_ACCESS_TOKEN=55a0fc5dd745e4b338f33e616d6fec2ee ceph_release_notes -r tags/v0.87..giant ../ceph |
||
| 12 | 1 | Loïc Dachary | </pre> |
| 13 | * manual edit the list of commits |
||
| 14 | * add a section in http://docs.ceph.com/docs/master/release-notes/ in the *master* branch of ceph in the "release-notes.rst":https://github.com/ceph/ceph/blob/master/doc/release-notes.rst file with the list of commits |
||
| 15 | * 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. |
||
| 16 | * add the release to the "timeline":https://github.com/ceph/ceph/blob/master/doc/release.rst |
||
| 17 | * the release notes come with an introduction that "is prepared in a separate file":https://github.com/ceph/ceph/blob/master/PendingReleaseNotes . It can be edited if something significant must not be forgotten and it does not need to well written because it is a draft. |