cerner_splunk icon indicating copy to clipboard operation
cerner_splunk copied to clipboard

Add a changelog for versions

Open garrypolley opened this issue 10 years ago • 2 comments

Generally most projects have some sort of change log for tracking changes between versions. How does this project do that? Would a simple changelog.md work?

garrypolley avatar Nov 13 '14 12:11 garrypolley

For the time being, the major/notable change log should be part of the annotated tag text which is (proposed) to be reviewed as part of the release issue. This text shows up on the releases list (apparently you need to click the ... now): https://github.com/cerner/cerner_splunk/releases

But it also shows up on the individual release text: https://github.com/cerner/cerner_splunk/releases/1.5.0

For the minor changes, we'll be using milestones on github issues / pull requests as they are accepted / merged. (step 5 of the committers.md): For example: https://github.com/cerner/cerner_splunk/issues?q=milestone%3Av1.6.0+

I don't want to add a manually maintained changelog.md until a case arises that is not covered easily by existing tools. As I think about it however, We really could use a project site. Maybe we could see if there's an octopress/jekyll plugin to generate changelogs by pulling data out of the github API?

acharlieh avatar Nov 13 '14 20:11 acharlieh

@acharlieh I think the idea of using some kind of documentation site that pulls in based on the annotated tag is a great idea.

If we did something to the versioning and the github issues tracking I think it could be pretty awesome. Pull in the tag information and then auto pull in the links to the milestones and issues on github.

garrypolley avatar Nov 14 '14 16:11 garrypolley