search

jnunemaker / httparty

:tada: Makes http fun again!
MIT License
5.79k stars 968 forks source link

Doc request: please explain which changes in 0.22 are breaking changes #801

Closed jaredbeck closed 3 months ago

jaredbeck commented 3 months ago

Looking at the 0.22 release notes it's not clear to me which changes are breaking changes.

If there are breaking changes, could you please annotate them?

If not, may I suggest adding a line like "No breaking changes" or "No changes to public API"?

In SemVer, 0.x.x libraries are allowed to make breaking changes at any time, so documentation like this will be very helpful.

Thanks!

jnunemaker commented 3 months ago

Dropping the support for old versions of Ruby was the breaking change.

On Wed, Jun 5, 2024 at 2:23 PM Jared Beck @.***> wrote:

Looking at the 0.22 release notes https://github.com/jnunemaker/httparty/releases/tag/v0.22.0 it's not clear to me which changes are breaking changes.

If there are breaking changes, could you please annotate them?

If not, may I suggest adding a line like "No breaking changes" or "No changes to public API"?

In SemVer, 0.x.x libraries are allowed to make breaking changes at any time, so documentation like this will be very helpful.

Thanks!

— Reply to this email directly, view it on GitHub https://github.com/jnunemaker/httparty/issues/801, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAAB25BMNXIDTYGZZP4Y6DZF5JTRAVCNFSM6AAAAABI3IAOC6VHI2DSMVQWIX3LMV43ASLTON2WKOZSGMZTMNJVGM2DQNY . You are receiving this because you are subscribed to this thread.Message ID: @.***>

jaredbeck commented 3 months ago

Dropping the support for old versions of Ruby was the breaking change.

IMHO, that's not a breaking change.

So, if that was the only notable change, I recommend adding a line like "No breaking changes" or "No changes to public API" to the release notes.

Thanks!

jaredbeck commented 3 months ago

On a related note, removing the top-level requires in https://github.com/jnunemaker/httparty/pull/760 may cause issues for some users who fail to require their own dependencies (speaking for a friend 😄 ) For example, if my friend's codebase requires CSV but they fail to specify that dependency in any way, then they will see NameError: uninitialized constant .. CSV after updating httparty to 0.22. This is not a breaking change in httparty, but you might choose, in an abundance of compassion, to mention it in the release notes. 😆

jnunemaker commented 3 months ago

@jaredbeck it is breaking if you use those versions. That's why I bumped. Most everything else should be pretty stable and has been for years.