HOWTO write the release notes » History » Version 12
Loïc Dachary, 08/04/2015 12:14 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 | 9 | Loïc Dachary | cd ceph/src/script |
| 6 | virtualenv v |
||
| 7 | source v/bin/activate |
||
| 8 | 6 | Abhishek Lekshmanan | pip install githubpy GitPython |
| 9 | 11 | Loïc Dachary | GITHUB_ACCESS_TOKEN=XXXXXXXXXXXXXX ceph-release-notes -r tags/v0.80.9..tags/v0.80.10 $(git rev-parse --show-toplevel) |
| 10 | 9 | Loïc Dachary | deactivate |
| 11 | 1 | Loïc Dachary | </pre> |
| 12 | 11 | Loïc Dachary | * 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 |
| 13 | <pre> |
||
| 14 | ERROR: http://github.com/ceph/ceph/pull/4884 title Keystone PKI token expiration is not enforced does not match ^(common|mon|osd|fs|librbd|rbd|fs|mds|objecter|rgw|build/ops|tests|tools|doc|crush|librados) |
||
| 15 | </pre> |
||
| 16 | the pull request title must be edited to add the required prefix. |
||
| 17 | 1 | Loïc Dachary | * 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 |
| 18 | 12 | Loïc Dachary | * create a pull request with this change and assign it to the Ceph lead |
| 19 | * add the text only version of the release notes as a comment to the pull request |
||
| 20 | <pre> |
||
| 21 | GITHUB_ACCESS_TOKEN=XXXXXXXXXXXXXX ceph-release-notes --text -r tags/v0.80.9..tags/v0.80.10 $(git rev-parse --show-toplevel) |
||
| 22 | </pre> |
||
| 23 | so that it can conveniently be copy/pasted when sending the mail announcing the release. |
||
| 24 | 1 | Loïc Dachary | * 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. |
| 25 | * add the release to the "timeline":https://github.com/ceph/ceph/blob/master/doc/release.rst |
||
| 26 | * 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. |
||
| 27 | 10 | Loïc Dachary | * the content of the "pending release notes":https://github.com/ceph/ceph/blob/master/PendingReleaseNotes file can be manually added at the beginning of the "release-notes.rst":https://github.com/ceph/ceph/blob/master/doc/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. |