ruby-magic icon indicating copy to clipboard operation
ruby-magic copied to clipboard

CHANGELOG.md is outdated

Open splattael opened this issue 5 years ago • 3 comments

:wave: I've noticed that the https://github.com/kwilczynski/ruby-magic/blob/main/CHANGELOG.md wasn't updated since v0.2.0.

Is there a way of automating the creation of this file?

Alternatively, it could be useful to create a PR template for releasing a new version where updating the CHANGELOG.md could be one of many bullet points to be checked off? :thinking:

splattael avatar Apr 09 '21 10:04 splattael

@kwilczynski What do you think about using https://github.com/github-changelog-generator/github-changelog-generator?

stanhu avatar Apr 09 '21 14:04 stanhu

Hello @splattael,

We don't have anything automated at the moment which is not the best user experience, indeed. Sincere apologies!

Krzysztof

kwilczynski avatar Apr 09 '21 15:04 kwilczynski

Hi @stanhu,

@kwilczynski What do you think about using https://github.com/github-changelog-generator/github-changelog-generator?

Looks good! I like there is a Rake task too.

The changelog format I keep updated manually in the past was that of Keep a Changelog too, so this project you suggested would hopefully just work for us.

Having said that, I need to manually update the changelog between 0.2.0 and 0.3.0 releases - as I have most of the context of what happened there and why. I hope this is OK.

Since we are on the subject of changelog, and thus releases, then I would to at some point focus on getting our Ruby Gems properly signed and so on, to ensure security and integrity of our releases.

Krzysztof

kwilczynski avatar Apr 09 '21 15:04 kwilczynski