Versioning introduces breaking changes in minor updates #3436
-
|
Hi, We went from 0.27.2 to 0.28.0 this morning which included this MR that introduced a number of breaking changes for us. It very much seems like your versioning follows semantic versioning (at least from how fixes etc get tracked under the patch number), but it doesn't seem to be case, as in this case you would have bumped the major version, given that you introduced backwards-incompatible changes. If you're not following semantic versioning, how should httpx's versioning be interpreted? Thank you |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 7 replies
-
|
semantic version allow adding breaking change before v1 |
Beta Was this translation helpful? Give feedback.
-
|
My memory is currect, they do have a paragraph about this in readme, and it is removed when they prepare a pre-1.0.0 release, and didn't add it back. |
Beta Was this translation helpful? Give feedback.
-
|
As a user I think they should add it back, but since now they are preparing a v1 release again I'm not sure will they do it. |
Beta Was this translation helpful? Give feedback.
-
|
So my personal opinion is that they should have delayed the above changes for the 1.0.0 release, since that's very clearly communicating breaking changes. Right now the library is in a sort of a limbo state that's both stable and also experimental, since presumably they want as much flexibility as they like, while not scaring people away by implying things are still very experimental. I imagine if 0.28.0 is the last release before 1.0.0 they probably don't see a reason to keep the notice that people should pin their library version, but I think you're right that they should keep it until they go to 1.0.0. |
Beta Was this translation helpful? Give feedback.
-
|
Agreed. We should be clear & direct about this...
(My assumption was that we were striking a reasonable balance with "API exists in 0.x, deprecate in 0.y, then remove in 0.z" tho evidently not cautious enough or clearly communicated.) PRs welcome for the above text/placement, or else I'll follow up with it as soon as possible. |
Beta Was this translation helpful? Give feedback.
Agreed. We should be clear & direct about this...
(My assumption was that we were striking a reasonable balance with "API exists in 0.x, deprecate in 0.y, then remove in 0.z" tho evidently not cautious enough or clearly communicated.)
PRs welcome for the above text/placement, or else I'll follow up with it as soon as possible.