Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Changelog generation from Github issues?

Tags:

Is there a way to automatically generate a change log from Github issues?

Ideally I want to be able to point at a closed milestone and generate either a plain text list of closed issues with their titles or, even better, a list with markup for links to the issues and the title of the issues themselves.

like image 659
James McMahon Avatar asked Feb 19 '13 15:02

James McMahon


People also ask

How do I make changelog automatically?

Auto-Generate ChangelogFollow the Conventional Commits Specification in your repository. We will use @commitlint/config-conventional to enforce this via Git hooks. Use standard-version, a utility for versioning using SemVer and changelog generation powered by Conventional Commits.

What is github changelog?

A changelog is a file that shares a chronologically ordered list of the changes you've made on your project. It's often organized by the version with the date followed by a list of added, improved, and removed features.


2 Answers

You can try to use Github-Changelog-Generator. (I'm author of this project)

It generates changelog from tags and merged pull-requests. This script also have a support of GitHub Issues.

This changelog was generated by this script. CHANGELOG.md

Example:

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)

like image 63
skywinder Avatar answered Sep 18 '22 14:09

skywinder


This isn't for Github specifically, but through Git you can run the log through pretty print to generate a changelog style html page.

From https://coderwall.com/p/5cv5lg

git log v2.1.0...v2.1.1 --pretty=format:'<li> <a href="http://github.com/jerel/<project>/commit/%H">view commit &bull;</a> %s</li> ' --reverse | grep "#changelog" 
like image 42
James McMahon Avatar answered Sep 18 '22 14:09

James McMahon