search

HewlettPackard / lustre_exporter

Prometheus exporter for use with the Lustre parallel filesystem
Apache License 2.0
36 stars 51 forks source link

Add CHANGELOG.md #80

Closed joehandzik closed 7 years ago

joehandzik commented 7 years ago

Created with github-changelog-generator

Signed-Off-By: Joe Handzik joseph.t.handzik@hpe.com

Fixes #55

joehandzik commented 7 years ago

I used this tool: https://github.com/skywinder/github-changelog-generator

I think the changelog is pretty good, personally. @mjtrangoni, any thoughts? Does this satisfy your goals for a CHANGELOG?

joehandzik commented 7 years ago

@roclark We already tagged the 0.01.0 release, so the cat's out of the bag there. It'll shift to 1.0.0 when we cut the next release, so there will only be a little bit of inconsistency if someone was using 0.01.0 (which should be a small group).

There's a little bit of sprawl, but this makes it easy to figure out what was done in each release. I took a short trip across the internet, and there are folks who think that the changelog needs to be thinned out, but I don't think this project will see as much churn in future releases as it has in these early releases. I think it'll be more useful than harmful to keep a detailed log.

roclark commented 7 years ago

Works for me! I think it looks good. As an aside, this is a very similar format to what the Lustre community uses for their changelog, so I think it's fitting.

Going to wait to see if @mjtrangoni has any comments - otherwise I will pull this in.

mjtrangoni commented 7 years ago

Nice! I didn`t know this tool. You could maybe remove the title, which seems redundant to me. Thanks!

joehandzik commented 7 years ago

@mjtrangoni The title is auto-generated, so in the interest of avoiding problems when re-running the tool for every release I'm going to leave it in there (it's a little redundant, but I don't think it really causes any problems).