redmile redmile - 1 month ago 15
Git Question

Git and changelog guideline

I'm a noob with git and i would like to know the best practice to create tags and generate/mantain a changelog.

Until now, i always created a readme.md and manually indicate (in the section "changelog") the most important feature

For example:


version 1.0.1


  • changed layout in home

  • added slideshow in gallery

  • etc..




How can i create a changelog (maybe in markdown format) with these characteristics?


  • title of changes based on personalized title/tags title/date

  • changes based on tags or commits



I do not have a clear idea yet, so suggestions are aprreciate

Thanks in advance :)

Answer

There is no some common guidelines yet. But A lot of good rules explained on keepachangelog.

And as they mention:

Dumping a diff of commit logs. Just don’t do that, you’re helping nobody.

And I'm fully agree with it.

Thats why I create Github Changelog Generator that generates Changelog according all these guidelines.

Actually it works with GitHub only, but it present a good example, how change log should look like.

It automatically generate change log from your tags, issues, labels and pull requests.

For example: This changelog was generated by this script: CHANGELOG.md

Changelog

1.2.5 (2015-01-15)

Full Changelog

Implemented enhancements:

  • Use milestone to specify in which version bug was fixed #22

Fixed bugs:

  • Error when trying to generate log for repo without tags #32

Merged pull requests:

  • PrettyPrint class is included using lowercase 'pp' #43 (schwing)

  • support enterprise github via command line options #42 (glenlovett)