-
-
Notifications
You must be signed in to change notification settings - Fork 24
update versioning settings… #460
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
Conversation
…th.patch versioning scheme
|
@armanbilge when you get a chance, could you please take a look at this and let me know what you think? Thanks! |
|
|
||
| ThisBuild / tlBaseVersion := "21.8" // TODO | ||
| ThisBuild / tlBaseVersion := "21.8" | ||
| ThisBuild / tlMimaPreviousVersions := Set.empty |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once we publish this under org.typelevel, we can set this value and start checking bincompat, at least within this library.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With some fiddling, hopefully it can set itself automatically via tags.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would be nice! Do you mean fiddling here or in sbt-typelevel?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably here. I purposely wanted to support only early-semver in sbt-typelevel to keep things simple(r).
I think the real question is how far back do you want to keep bincompat? Just per month-year, or something more ad-hoc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm leaning towards continuing to use the year.month.patch scheme in this repo, in part to keep things inline with Finagle, and in part because I'm not sure what version we'd start with if we switched over to another scheme, like early-semver. (e.g. if we switched to 1.0.0, then Scala Steward is going to consider 21.8.0 to be the newest version for a long time.)
If we continue to use year.month.patch, then I would consider year.month to be the major version, meaning we should feel free to break bincompat with each monthly release, but we maintain bincompat within a month if we make subsequent releases. If we can make it happen, I'd like to take it a step further and only introduce a break in a given month if Finagle or Twitter Utils also introduces a break, but I don't know if that's strictly necessary.
Codecov Report
@@ Coverage Diff @@
## main #460 +/- ##
=======================================
Coverage 91.21% 91.21%
=======================================
Files 18 18
Lines 296 296
Branches 2 2
=======================================
Hits 270 270
Misses 26 26 Continue to review full report at Codecov.
|
armanbilge
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's give this a try!
…so we can publish using Finagle's
year.month.patchversioning scheme.This should fix #456.