Document breaking changes

[joelmukuthu]

Hi,

Would it be an option to document breaking changes in the CHANGELOG? This could also be done on the releases on GitHub but it seems they are not used as much.

What were the breaking changes introduced in v11?

Best,
Joel

[profnandaa]

Hi Joel -- this is a good idea. I think, we've not been using the semver standard for the versioning, so whenever you see a jump from 10 -> 11 is not actually a breaking change. @chriso you can correct me

However, the idea of updating breaking changes in the CHANGELOG.md is a good one 👍

[chriso]

We loosely follow semver and bump the major version whenever breaking changes are introduced.

For v11, we removed an internal toString function. It was accidentally exported in <=10 so removing it may have broken downstream code, despite it being an undocumented internal function.

[profnandaa]

Got it, my bad 👍

On Tue, Sep 17, 2019 at 12:59 AM chriso ***@***.***> wrote: We loosely follow semver <https://semver.org> and bump the major version whenever breaking changes are introduced. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1106?email_source=notifications&email_token=AAB7ZENOV3I5VDOBBPNCWXDQJ76V5A5CNFSM4IWM6L22YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD62UV6A#issuecomment-531974904>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAB7ZEJ5RW7WQKKDB46DLFTQJ76V5ANCNFSM4IWM6L2Q> .

-- Sent from a tiny device while on the move.

[joelmukuthu]

Thanks for the responses @profnandaa and @chriso.

I think #1007 was also a breaking change? (I couldn't find the PR when I created the issue but I seemed to remember seeing something about new email validation possibly causing breaking changes, and now I went digging for it).

From what I understand from that change, emails longer than 254 characters were previously valid but not anymore as of v11. Is that correct?

[joelmukuthu]

Hi, were there any breaking changes in v13?

I have gone through the list of commits and I'm afraid I can't figure it out.

Have you considered using a changelog generator since you use conventional commits?

[profnandaa]

@joelmukuthu -- thanks for the heads-up. I'm not sure if this could be treated as a breaking change since initial tests that were passing will now fail...

But @chriso can clarify v13 jump.

[MatthewHerbst]

Bump on this please. It's really unclear if upgrading to v13 is safe or not. cc @profnandaa @chriso Thank you for keeping this package awesome!

[profnandaa]

Thanks for the heads-up, we'll clarify. ./na

On Thu, Dec 31, 2020 at 6:14 AM Matthew Herbst ***@***.***> wrote: Bump on this please. It's really unclear if upgrading to v13 is safe or not. cc @profnandaa <https://github.com/profnandaa> @chriso <https://github.com/chriso> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1106 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB7ZEMON2IHZLATMWYQBQLSXPUC3ANCNFSM4IWM6L2Q> .

-- Sent from a tiny device while on the move.

[chriso]

#1267 was the breaking change for v13. I was strictly following semver, and the contract on an existing validator was weakened by that change.