Changelog: Listing breaking changes

[codebycliff]

Would it be possible to list your breaking changes in the CHANGELOG.md for future releases? We have a bot that opens up pull requests for gem updates. This is the first gem update I have seen in quite a while that doesn't explicitly list the breaking changes. I can spot obvious ones (e.g. dropping support for ruby < 2.0), but I am not familiar with the codebase enough to determine other possible breaking changes from the list. Thanks!

[geemus]

Noted. I think the ruby version change is the only expected breaking change, fwiw.

[codebycliff]

Thanks! Much appreciated.

[github-actions]

This issue has been marked inactive and will be closed if no further activity occurs.

[ryanb]

This has been closed, but I don't see a "breaking changes" section in the changelog.

I too would appreciate a section stating any breaking changes or simply state "No breaking changes" if there are none. It's difficult to automate the testing of AWS integration. Knowing if there are any breaking changes helps us to decide what level of manual testing is necessary when upgrading.

Either way, thanks for maintaining the gem!

[geemus]

@ryanb Hey. We do our best to use semantic versioning, so there shouldn't be breaking changes outside of a major release. It sounds like you might want it called out more explicitly for majors though. Do you have an example of a changelog that you think does this really well to help me maybe model after as I think about this?

[ryanb]

@geemus I like paper_trail's changelog which has three sections for each version: breaking changes, additions, and fixes. It states if there are "none" in the area.

Alternatively, a note at the top stating it's using semantic versioning, and breaking changes will only be in a major version would help.

Thanks!

[geemus]

@ryanb thanks for that. I expect semantic versioning, fwiw. Unfortunately the changelog is generated, so adding a notice isn't quite so easy. I suspect it shouldn't be TOO hard, but I'll need to dig in to make sure it doesn't just get clobbered/removed when we generate new changelogs in the future.

[github-actions]

This issue has been marked inactive and will be closed if no further activity occurs.

[geemus]

Sorry still meaning to get to this, but just hasn't risen to a high priority. Will pin it at least to stop stale bot from bugging us.