jwt-framework icon indicating copy to clipboard operation
jwt-framework copied to clipboard

The changelog for 4.0 does not mention BC breaks

Open stof opened this issue 9 months ago • 4 comments

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 avatar Mar 12 '25 16:03 stof

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.

stof avatar Mar 12 '25 16:03 stof

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Apr 26 '25 01:04 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jun 27 '25 01:06 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jul 29 '25 04:07 stale[bot]