Skip to content

Conversation

@bpholt
Copy link
Member

@bpholt bpholt commented May 31, 2022

…so we can publish using Finagle's year.month.patch versioning scheme.

This should fix #456.

@bpholt bpholt self-assigned this May 31, 2022
@bpholt
Copy link
Member Author

bpholt commented May 31, 2022

@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
Copy link
Member Author

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.

Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member

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?

Copy link
Member Author

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-commenter
Copy link

codecov-commenter commented May 31, 2022

Codecov Report

Merging #460 (e3f9f23) into main (ef7e016) will not change coverage.
The diff coverage is n/a.

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ef7e016...e3f9f23. Read the comment docs.

Copy link
Member

@armanbilge armanbilge left a 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!

@bpholt bpholt merged commit ff1f54e into typelevel:main May 31, 2022
@bpholt bpholt deleted the publishing branch May 31, 2022 22:17
@bpholt bpholt mentioned this pull request May 31, 2022
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

Successfully merging this pull request may close these issues.

Publishing broken

3 participants