Thoughts about CHANGELOG

[kuraga]

Good day!

Maybe it's not an important thing but I'm thinking about CHANGELOG :-)

1. What is the sense of change logs for 1.0.0.betaX after 1.1.0 release?
2. Some changes will be added (removed, changed) in 1.0.0betaX and then removed (added back, changed) in 1.0.0betaY (X > Y). Maybe store last change only in CHANGELOG? Then we can do small 0.18.0..1.0.0 changelog (not upgrade guide nor commit history). Current CHANGELOG... I don't know what to do with it then :-)
3. Maybe store short commit-links only in CHANGELOG? It's unreadability now...

I can help you with it. And where is 1.1.0 CHANGELOG? Thanx :-)

[haines]

I've added the changelog for 1.1.0, and shortened the commit links.

I agree that the 1.0.0 bit has gotten a bit confusing with the changes in early betas that were reverted or changed further in later betas. However with 249 commits between 0.18 and 1.0 it's not a trivial undertaking to redo it!

[steveklabnik]

Ya I forgot 1.1.0 Changelog, my bad :(

On Jan 29, 2013, at 8:11 AM, Andrew Haines notifications@github.com wrote:

I've added the changelog for 1.1.0, and shortened the commit links.

I agree that the 1.0.0 bit has gotten a bit confusing with the changes in early betas that were reverted or changed further in later betas. However with 249 commits between 0.18 and 1.0 it's not a trivial undertaking to redo it!

—
Reply to this email directly or view it on GitHub.

[killthekitten]

@kuraga it has sense, since some users could get stuck on any of the old versions, including betas. Today I understood that 0.17 -> 1.0 is a painful process.

[steveklabnik]

Yes, some sort of 'upgrading guide' would be nice to have. Marking this as a feature request. :)

[haines]

https://github.com/drapergem/draper/wiki/Upgrading-to-1.0 😉

[steveklabnik]

Ha! Then done!

[kuraga]

@killthekitten ok, that's an argument. I think it'll be good to make first release with current version of API (1.0?) as an initial version in CHANGELOG in the future. (Now "initial version" is 0.X=0.18.) That's only an opinion :)