search

brendanhay / amazonka

A comprehensive Amazon Web Services SDK for Haskell.
https://amazonka.brendanhay.nz
Other
605 stars 227 forks source link

Create/update a changelog as part of the release process #30

Open brendanhay opened 9 years ago

brendanhay commented 9 years ago

I like reading other people's changelogs.

I don't like writing them.

I should write a generator for the changelog! Then hand massage the output into something that can piggyback along with any release notes.

axman6 commented 8 years ago

Sublime Text's Git Savvy package can create a "changelog" with a list of commit messages, and the names of the contributors, all you do is specify the hash (or more often tag) that is the start of the changelog and it will get every message since that hash/tag.

brendanhay commented 8 years ago

Thanks for the headsup. I've gone through a number of the most popular changelog generators and decide they either all suck, my commit messages suck, or having to manually mention what has changed upstream in botocore sucks. Since the latter is required, I've just been doing it from a markdown template since the commit volume has slowed post 1.0 release.

proger commented 8 years ago

Your PRs look comprehensive enough, why not simply list closed issues/PRs?

proger commented 8 years ago

(perhaps the other important thing would be to mention botocore version correspondence)

brendanhay commented 8 years ago

I have tried, but end up hand editing everything anyway. Not a huge issue as it stands now. But separately, yes, having some correspondence (by way of version or something) with botocore would be nice.