Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The changelog for 4.0 does not mention BC breaks #609

Open
stof opened this issue Mar 12, 2025 · 1 comment
Open

The changelog for 4.0 does not mention BC breaks #609

stof opened this issue Mar 12, 2025 · 1 comment

Comments

@stof
Copy link
Contributor

stof commented Mar 12, 2025

Description

Based on the mentioned changes, I think that those BC breaks were done as part of the "Preparing 4.0.0" change, but this is not explanatory for readers of those release notes.
Mentioning the BC breaks of a major version is probably the most important part of release notes, as far as consumers of the project are concerned.

@stof
Copy link
Contributor Author

stof commented Mar 12, 2025

From a quick look, it seems like the constructor signatures have changed for a bunch of classes (the ones dealing with a clock for instance), because of changing the order of arguments. This is quite important to know about it, and even https://web-token.spomky-labs.com/migration/from-v1.x-to-v2.0-2 does not mention it (it mentions that the clock is mandatory, but not the argument reordering).

As I now discovered this migration guide in the doc, I think linking to it from the release notes might be enough (if it is updated to be complete).
Side note: the URL of that migration guide from 3.x to 4.0 is quite weird.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant