Using releasenotes extension for 4.4 cycle

Gregory Szorc gregory.szorc at gmail.com
Sun Jul 23 18:39:21 UTC 2017


Rishabh has been doing great work on the releasenotes extension.

I'd like to start using it as part of developing Mercurial itself. And the
sooner we do that, the sooner we'll flush out bugs, pain points, etc.

I'd like to propose attempting to use the releasenotes extension for the
duration of the 4.4 cycle. I imagine this entails the following:

* Bike shedding on the sections/admonitions to use for Mercurial itself
(the default sections in the extension today might be good enough because
they were modeled after Mercurial)
* Encouraging patch authors to include admonitions in commit messages
* Encouraging reviewers to add admonitions to commit messages when commits
are queued
* Possibly codifying requirements for the use of admonitions so
test-check-commit and other tools like phabsend issue warnings/errors
(although I'm not sure how to formalize a requirement since not all commits
deserve a release note and defining/detecting a "series" is hard since you
can have partial landings)

Initially, we don't have to generate/store the release notes files in the
repo. But at some point we'll want to do that. I imagine that can be done
as part of the "publishing" step that reviewers perform. We should probably
wait for releasenotes to gain better similarity checking / file merging
before we add/update release notes files in the repo.

Is this a realistic goal? Are there any other blockers?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.mercurial-scm.org/pipermail/mercurial-devel/attachments/20170723/048378b4/attachment.html>


More information about the Mercurial-devel mailing list