Replace svn2cl with a git-based tool to generate ChangeLog

[networkupstools]

Replace svn2cl with a git-based tool to generate ChangeLog

[clepple]

@aquette: what are the priorities for the ChangeLog? Full GNU standards compliance? Match the same format as before?

Also, now that the Git commit messages have a summary line at the top, do we want the full commit text, or just the summary and the list of files?

How far back do we want to go?

I'm looking at a few options:

• http://savannah.nongnu.org/git/?group=git2cl is probably closest to the GNU standard, but it includes the entire commit message.
• https://github.com/cryos/avogadro/blob/master/scripts/gitlog2changelog.py is similar, but the formatting seems off.
• https://github.com/buildbot/buildbot/blob/master/master/contrib/generate_changelog.py uses the short log message, but would need some formatting help as well.

I'm open to other suggestions.

[aquette]

@clepple: the same format suits me fine, especially when it comes to making
new releases ;)
that said, the aim of ChangeLog is to provide a detailed view, completing
the Release note (NEWS file).

but I'm not 100 % decided on my side.
if you think the short version is worth, we can have a 2 levels mechanism,
that provides just sum. lines + a target (ChangeLog-full for example) that
provides a full version.

samples output may help deciding finally.
bounce...

[clepple]

@aquette see https://gist.github.com/clepple/5030209 for the long format.

Still working out why it drops some of the entries that show up in the log output. If I don't waste too much time tracking that down, I'll look at shortening it.

[aquette]

@clepple: https://gist.github.com/clepple/5030209 looks great!

[clepple]

Hmm, some files are still missing. I'm going to switch to another script.

[aquette]

Files or entries?

(sent from my S3... please excuse my brevity)
Le 26 févr. 2013 04:23, "clepple" [email protected] a écrit :

Hmm, some files are still missing. I'm going to switch to another script.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/4#issuecomment-14090422
.

[clepple]

Changelog entries. I was still shaking my head over the fact that the script matches the word "files" to get the end of the list of changed files.

[aquette]

@clepple: what would be great is to be able to pass the base-revision arg from the Makefile call, as with svn before.
that way, things are less scattered.

[clepple]

@aquette just the base revision, right?

I can't think of why we would want to do anything other than base..HEAD in the 'git log' command line.

Also note that I kept the feature of the original gitlog2changelog.py where it ignores merge commit messages, and just looks at the changes on either side of the merge. It puts a little more emphasis on the branch commit messages, but if it's a clean merge, there shouldn't be any extra information in the merge commit itself. And if people really care, they can always look at the full Git history.

[aquette]

2013/2/28 clepple [email protected]

@aquette just the base revision, right?

right

I can't think of why we would want to do anything other than base..HEAD in
the 'git log' command line.

so do I, at least not part of the present scope.

Also note that I kept the feature of the original gitlog2changelog.py
where it ignores merge commit messages, and just looks at the changes on
either side of the merge. It puts a little more emphasis on the branch
commit messages, but if it's a clean merge, there shouldn't be any extra
information in the merge commit itself. And if people really care, they can
always look at the full Git history.

suits me fine

thx

[clepple]

I should have written "Fixes #4" in the commit message for b00e1df. Closing this issue.