Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Add a changelog for versions #10

Open
garrypolley opened this issue Nov 13, 2014 · 2 comments
Open

Add a changelog for versions #10

garrypolley opened this issue Nov 13, 2014 · 2 comments

Comments

@garrypolley
Copy link
Contributor

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?

@acharlieh
Copy link
Contributor

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?

@garrypolley
Copy link
Contributor Author

@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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants