Replies: 2 comments 3 replies
-
I would like to advocate bumping the major version to 2 in such a case (following semver v2.0.0). As you've left the unstable version range (aka major version 0) by bumping to major version 1 the Go Modules Reference compatibility requirements are pretty clear: The major version must be incremented and the minor and patch versions must be set to zero after a backwards incompatible change is made to the module's public interface or documented functionality, for example, after a package is removed. Also: Major version suffixes implement the import compatibility rule: If an old package and a new package have the same import path, the new package must be backwards compatible with the old package. These breaking changes do not comply with the Go modules expectations. Using Thus, the v1.1.0 release would have been nicer as a v2.0.0 release. Then, just by looking at the version number i.e. without even reading the README or Changes files, developers would immediately expect breaking changes when the deciding to upgrade their Please consider for the next releases. |
Beta Was this translation helpful? Give feedback.
-
Please reconsider this. It's against any good practice. API changes must be visible in the version string. Besides: Once you get to see any real life problems it will be too late to do the right thing. You then must find all kind of workarounds to support people. Keep in mind that not everybody can update to current versions immediately (e.g. for technical or policy reasons). So these problems will haunt you.... |
Beta Was this translation helpful? Give feedback.
-
I just release jwx v1.1.0. As announced previously, there are many API changes.
The new API should be much more consistent and streamlined (especially so if you have been following this project since the pre-v1.0.0 days)
If you do not want to deal with the changes, make sure you are using go.mod with proper version specifications.
The list of changes is too big to cover in one post, but I encourage you to take a look at both the new README and the Changes file.
Thank you for those of you who helped me in the last couple of weeks while I worked on the new version.
I hope this library is useful to someone out there. Enjoy!
Beta Was this translation helpful? Give feedback.
All reactions