fixing inconsistent merge messages & release notes

fixing inconsistent merge messages & release notes

[Loic Dachary]

Hi,

TL;DR: Fix the PR title via the GitHub web interface, not in the merge message. 
       Use the merge message to write a user readable paragraph that will show in the release notes.

A few month ago it was proposed that merge messages are improved to help write better release notes, but that did not quite succeed. Yet :-)

When using the GitHub web interface, the default merge message looks like that:

    Merge pull request #7037 from mathslinux/rgw-add-missing-error-code
    rgw: add missing error code for admin op API
    Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>

Where the first two lines (Merge and rgw: ...) are automatically generated by GitHub using the title of the pull request. And the Reviewed-By: is added manually by the reviewer.

If the title of the pull request needs fixing, it can also be done via the GitHub web interface and it will reflect in the merge message template. It is convenient because the title of the pull request exactly matches the title found in the merge message. Fixing the title in the merge message leaves us with an unnecessary inconsistency between the merge message and the title of the pull request. I manually fixed a few dozens of such inconsistencies by copying the merge message back to the pull request title for the 10.0.3 release.

The script used to list the notable changes for the release notes[1] will assume merge messages that are not the default (see above) are written for inclusion in the release notes. For instance https://github.com/ceph/ceph/pull/6926 title is ceph-disk: fix failures when preparing disks with udev > 214 and the merge message is:

    Merge pull request #6926 from dachary/wip-14080-ceph-disk-udevadm
    ceph-disk: fix failures when preparing disks with udev > 214

    On CentOS 7.1 and other operating systems with a version of udev greater or equal to 214, 
    running ceph-disk prepare triggered unexpected removal and addition of partitions on
    the disk being prepared. That created problems ranging from the OSD not being activated
    to failures because /dev/sdb1 does not exist although it should.

    Reviewed-by: Sage Weil <sage@redhat.com>

The two examples above will show as follows in the release notes:

* rgw: add missing error code for admin op API (`pr#7037 <http://github.com/ceph/ceph/pull/7037>`_, Dunrong Huang)
* ceph-disk: fix failures when preparing disks with udev > 214 (`issue#14080 <http://tracker.ceph.com/issues/14080>`_, `issue#14094 <http://tracker.ceph.com/issues/14094>`_, `pr#6926 <http://github.com/ceph/ceph/pull/6926>`_, Loic Dachary, Ilya Dryomov)
    On CentOS 7.1 and other operating systems with a version of udev greater or equal to 214,
    running ceph-disk prepare triggered unexpected removal and addition of partitions on
    the disk being prepared. That created problems ranging from the OSD not being activated
    to failures because /dev/sdb1 does not exist although it should.


Cheers

[1] https://github.com/ceph/ceph/blob/master/src/script/ceph-release-notes
-- 
Loïc Dachary, Artisan Logiciel Libre
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html