Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CHANGELOG.md is outdated #18

Open
splattael opened this issue Apr 9, 2021 · 3 comments
Open

CHANGELOG.md is outdated #18

splattael opened this issue Apr 9, 2021 · 3 comments
Assignees
Labels

Comments

@splattael
Copy link

👋 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? 🤔

@stanhu
Copy link
Collaborator

stanhu commented Apr 9, 2021

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

@kwilczynski
Copy link
Owner

Hello @splattael,

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

Krzysztof

@kwilczynski
Copy link
Owner

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 kwilczynski self-assigned this Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants