search

reidmorrison / symmetric-encryption

Symmetric Encryption for Ruby Projects using OpenSSL
https://logger.rocketjob.github.io/
Apache License 2.0
476 stars 92 forks source link

Delete or update CHANGELOG.md #144

Closed cyclotron3k closed 3 years ago

cyclotron3k commented 4 years ago

CHANGELOG.md hasn't been updated for a while. Makes me a little nervous when new versions are published, but the changelog has no reference to the new version. In the past this has indicated a compromised gem. Makes me doubly nervous when the gem is security related.

I'd suggest either deleting CHANGELOG.md or updating it.

If you'd like to update it, but don't have the time I can probably submit a PR.

As usual, thanks for all your hard work.

jaredbeck commented 2 years ago

Was the changelog moved somewhere, or just deleted? I'm trying to determine if there were breaking changes between 4.3 and 4.4. Where would I find those documented, please, if any?

If you choose to reinstate a changelog, I can recommend the format and tips in https://keepachangelog.com/en/1.0.0/. I use it for my projects.

@reidmorrison

reidmorrison commented 2 years ago

If there are any breaking changes between versions they will be mentioned in the readme.md file, along with instructions on how to upgrade.

jaredbeck commented 2 years ago

Thanks for the reply, Reid. I will try to remember to look in the readme in the future. CHANGELOG.md is a very strong convention in the ruby community, though. It's where everyone is going to look first. But, it's your project :) Thanks for sharing your work, and best wishes for the new year.