GSoC 17: Release notes extension

Rishabh Madan rishabhmadan96 at gmail.com
Tue Mar 21 01:04:06 UTC 2017


Hello,

I am Rishabh Madan and I will be a GSoC applicant this year under Mercurial.

I wanted to discuss about the Release notes extension project.[1]
<https://www.mercurial-scm.org/wiki/SummerOfCode/Ideas2017>
I have gone through the mailing list discussions. I am currently
understanding the intial patch sent by Gregory Szorc, for the releasenotes
extension.

I would like to get a few inputs for this project:

1. Commit message parser
(i) I feel this is the core of the idea. From what I understand, we will
have to keep a specific format for the commit messages that will be parsed
and output will be stored in a changelog. But, this is a extension that
would help other organizations as well. Do we expect them to abide by
certain format for the commit message?
(ii) Is this going to be a hybrid process? I mean, will the notes once
created be edited by maintainers at a later stage?
(iii) The extension shouldn't add extremely small changesets to the
changelog. I think this can be done by adding some keyword to the commit
message (like [IGNORERST]).

2. Linking hgweb to release notes
I found this idea quite intriguing. Can someone please elaborate a bit more
on what exactly we're trying to accomplish with this?

I also found some open source implementations like [2]
<https://github.com/skywinder/github-changelog-generator> similar to this
idea that might help in implementing this project.


I would really appreciate if someone can point out the issues and features
I may have missed. Also, any relevant resources or links for further
readings would help too.

Thanks.
Rishabh Madan
ᐧ
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.mercurial-scm.org/pipermail/mercurial-devel/attachments/20170321/281f0916/attachment.html>


More information about the Mercurial-devel mailing list