search

lloydmeta / enumeratum

A type-safe, reflection-free, powerful enumeration implementation for Scala with exhaustive pattern match warnings and helpful integrations.
MIT License
1.18k stars 146 forks source link

Breaking compatibility should trigger a major version update #358

Open Bryji opened 1 year ago

Bryji commented 1 year ago

The 1.7.1 release were noted that:

WARNING: this version and above are not binary compatible with previous versions

I suggest that going by the semver rules, this should trigger a major release version change (2.0.0). Consider e.g. projects with multiple transitive dependencies to Enumeratum - these would all now need to be upgraded in sync, which would be unexpected for a point release (patch) update.

lloydmeta commented 1 year ago

Indeed, it should have but it was discovered after the release.

I'll keep this issue open since we don't have an issue for adding a checker for this but do have an open PR.

https://github.com/lloydmeta/enumeratum/pull/315

Please feel free to contribute ^

Bryji commented 1 year ago

Ah, I see. Thanks for the reply @lloydmeta