Major maintenance update - add Scala 2.13, drop 2.12

migesok · migesok · commit 6269592ca4e6 · 2025-09-18T14:01:56.000+03:00
Due to updated dependencies in this change and before that,
the next release has to be 6.0.0.

* Updated Scala versions, added support for Scala 3.
* New dependency versions forced dropping Scala 2.12 - bye bye!
* Updated sbt, plugins, dependencies.
* Added bincompat checks.
* Updated gitlab actions to the latest.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,6 @@
 name: CI
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
   test:
@@ -10,18 +10,26 @@ jobs:
     strategy:
       matrix:
         scala:
-          - 2.13.15
-          - 2.12.20
+          - 2.13.16
+          - 3.3.6
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: coursier/cache-action@v5
+      - uses: coursier/cache-action@v6
 
-      - name: scala
-        uses: olafurpg/setup-scala@v10
+      - name: setup Java 17
+        uses: actions/setup-java@v4
         with:
-          java-version: openjdk@1.11
+          java-version: '17'
+          distribution: 'oracle'
+          cache: 'sbt'
+
+      - name: setup SBT
+        uses: sbt/setup-sbt@v1
+
+      - name: check code ${{ matrix.scala }}
+        run: sbt ++${{ matrix.scala }} clean check
 
       - name: build ${{ matrix.scala }}
         run: sbt ++${{ matrix.scala }} clean coverage test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,11 +1,11 @@
-name: Publish new Release
+name: Publish Release
 
 on:
-  release:
-    types: [published]
-    branches: [master]
+  push:
+    tags:
+      - 'v*'
 
 jobs:
   release:
-    uses: evolution-gaming/scala-github-actions/.github/workflows/release.yml@v1
+    uses: evolution-gaming/scala-github-actions/.github/workflows/release.yml@v4
     secrets: inherit
diff --git a/build.sbt b/build.sbt
@@ -1,6 +1,7 @@
-import Dependencies._
+import Dependencies.*
 
 ThisBuild / versionScheme := Some("semver-spec")
+ThisBuild / versionPolicyIntention := Compatibility.BinaryCompatible
 
 lazy val modules: List[ProjectReference] = List(
   `stracer`,
@@ -15,23 +16,33 @@ lazy val root = project
   .settings(commonSettings)
   .settings(alias)
   .settings(publish / skip := true)
-  .aggregate(modules: _*)
+  .aggregate(modules *)
 
 lazy val `stracer` = project
   .settings(commonSettings)
   .settings(
     libraryDependencies ++= Seq(
       zipkin,
       random,
-      Scodec.core,
       Scodec.bits,
       `cats-helper`,
       Cats.core,
       CatsEffect.effect,
       configTools,
-      Pureconfig.pureconfig,
       scalatest % Test,
     ),
+    libraryDependencies ++= crossSettings(
+      scalaVersion = scalaVersion.value,
+      if2 = Seq(
+        Pureconfig.Scala2.pureconfig,
+        Scodec.Scala2.core,
+      ),
+      if3 = Seq(
+        Pureconfig.Scala3.core,
+        Pureconfig.Scala3.generic,
+        Scodec.Scala3.core,
+      ),
+    ),
   )
 
 lazy val `stracer-play-json` = project
@@ -64,15 +75,45 @@ val commonSettings = Seq(
   organizationName := "Evolution",
   organizationHomepage := Some(url("https://evolution.com")),
   scalaVersion := crossScalaVersions.value.head,
-  crossScalaVersions := Seq("2.13.15", "2.12.20"),
-  releaseCrossBuild := true,
+  crossScalaVersions := Seq("2.13.16", "3.3.6"),
+  scalacOptions ++= Seq(
+    "-release:17",
+    "-deprecation",
+  ),
+  scalacOptions ++= crossSettings(
+    scalaVersion = scalaVersion.value,
+    if2 = Seq(
+      "-Xsource:3",
+    ),
+    // Good compiler options for Scala 2.13 are coming from com.evolution:sbt-scalac-opts-plugin:0.0.9,
+    // but its support for Scala 3 is limited, especially what concerns linting options.
+    //
+    // If Scala 3 is made the primary target, good linting scalac options for it should be added first.
+    if3 = Seq(
+      "-Ykind-projector:underscores",
+
+      // disable new brace-less syntax:
+      // https://alexn.org/blog/2022/10/24/scala-3-optional-braces/
+      "-no-indent",
+
+      // improve error messages:
+      "-explain",
+      "-explain-types",
+    ),
+  ),
   licenses := Seq(("MIT", url("https://opensource.org/licenses/MIT"))),
   publishTo := Some(Resolver.evolutionReleases),
   scalacOptsFailOnWarn := Some(false),
 )
 
 val alias: Seq[sbt.Def.Setting[?]] =
-  //  addCommandAlias("check", "all versionPolicyCheck Compile/doc") ++
-  addCommandAlias("check", "all Compile/doc scalafmtCheckAll scalafmtSbtCheck") ++
+  addCommandAlias("check", "all versionPolicyCheck Compile/doc scalafmtCheckAll scalafmtSbtCheck") ++
     addCommandAlias("build", "+all compile test") ++
     addCommandAlias("fmt", "+all scalafmtAll scalafmtSbt")
+
+def crossSettings[T](scalaVersion: String, if3: T, if2: T): T = {
+  scalaVersion match {
+    case version if version.startsWith("3") => if3
+    case _ => if2
+  }
+}
diff --git a/project/Dependencies.scala b/project/Dependencies.scala
@@ -1,50 +1,63 @@
-import sbt._
+import sbt.*
 
 object Dependencies {
 
-  val scalatest = "org.scalatest" %% "scalatest" % "3.2.15"
+  val scalatest = "org.scalatest" %% "scalatest" % "3.2.19"
   val zipkin = "io.zipkin.zipkin2" % "zipkin" % "2.21.6"
-  val `cats-helper` = "com.evolutiongaming" %% "cats-helper" % "3.5.0"
-  val random = "com.evolutiongaming" %% "random" % "1.0.0"
-  val configTools = "com.evolutiongaming" %% "config-tools" % "1.0.4"
-  val skafka = "com.evolutiongaming" %% "skafka" % "17.1.2"
+  val `cats-helper` = "com.evolutiongaming" %% "cats-helper" % "3.12.2"
+  val random = "com.evolution" %% "random" % "1.0.5"
+  val configTools = "com.evolutiongaming" %% "config-tools" % "1.0.5"
+  val skafka = "com.evolutiongaming" %% "skafka" % "17.2.0"
 
   object Cats {
-    private val version = "2.8.0"
+    private val version = "2.13.0"
     val core = "org.typelevel" %% "cats-core" % version
   }
 
   object CatsEffect {
-    private val version = "3.5.3"
+    private val version = "3.5.7"
     val effect = "org.typelevel" %% "cats-effect" % version
   }
 
   object Scodec {
-    val core = "org.scodec" %% "scodec-core" % "1.11.7"
-    val bits = "org.scodec" %% "scodec-bits" % "1.1.18"
+    val bits = "org.scodec" %% "scodec-bits" % "1.2.4"
+
+    // see https://github.com/scodec/scodec/issues/365
+    object Scala2 {
+      val core = "org.scodec" %% "scodec-core" % "1.11.11" // the last scodec-core version built for 2.13
+    }
+
+    object Scala3 {
+      val core = "org.scodec" %% "scodec-core" % "2.3.3"
+    }
   }
 
   object PlayJsonTools {
-    private val version = "1.1.1"
+    private val version = "1.2.3"
 
     val tools = "com.evolution" %% "play-json-tools" % version
   }
 
   object Circe {
-    private val version = "0.14.9"
-    private val versionExtras = "0.14.1"
+    private val version = "0.14.14"
 
     val core = "io.circe" %% "circe-core" % version
     val generic = "io.circe" %% "circe-generic" % version
     val parser = "io.circe" %% "circe-parser" % version
-    val `generic-extras` = "io.circe" %% "circe-generic-extras" % versionExtras
 
-    val all: Seq[ModuleID] = Seq(core, generic, parser, `generic-extras`)
+    val all: Seq[ModuleID] = Seq(core, generic, parser)
   }
 
   object Pureconfig {
-    private val version = "0.17.3"
-    val pureconfig = "com.github.pureconfig" %% "pureconfig" % version
-    val cats = "com.github.pureconfig" %% "pureconfig-cats" % version
+    private val version = "0.17.8"
+
+    object Scala2 {
+      val pureconfig = "com.github.pureconfig" %% "pureconfig" % version
+    }
+
+    object Scala3 {
+      val core = "com.github.pureconfig" %% "pureconfig-core" % version
+      val generic = "com.github.pureconfig" %% "pureconfig-generic-scala3" % version
+    }
   }
 }
diff --git a/project/build.properties b/project/build.properties
@@ -1 +1 @@
-sbt.version=1.10.2
+sbt.version=1.11.6
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -1,6 +1,7 @@
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.2.1")
-addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.3.1")
-addSbtPlugin("com.github.sbt" % "sbt-release" % "1.1.0")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.3.1")
+addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.3.15")
 addSbtPlugin("com.evolution" % "sbt-scalac-opts-plugin" % "0.0.9")
 addSbtPlugin("com.evolution" % "sbt-artifactory-plugin" % "0.0.2")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.5")
+addSbtPlugin("com.github.sbt" % "sbt-dynver" % "5.1.1")
+addSbtPlugin("ch.epfl.scala" % "sbt-version-policy" % "3.2.1")
diff --git a/stracer-kafka/src/main/scala/com/evolutiongaming/stracer/ReportSpanRecord.scala b/stracer-kafka/src/main/scala/com/evolutiongaming/stracer/ReportSpanRecord.scala
@@ -38,7 +38,7 @@ object ReportSpanRecord {
       producerConfig <- config.getOpt[Config]("kafka.producer").map(ProducerConfig(_))
     } yield {
       val topic = config.getOpt[String]("topic") getOrElse "jaeger"
-      implicit val toBytes = ToBytesOf(SpanBytesEncoder.THRIFT)
+      implicit val toBytes: ToBytes[F, Nel[SpanRecord]] = ToBytesOf(SpanBytesEncoder.THRIFT)
       of[F](topic, producerConfig, enabled, producerOf)
     }
 
diff --git a/stracer-kafka/src/main/scala/com/evolutiongaming/stracer/ToBytesOf.scala b/stracer-kafka/src/main/scala/com/evolutiongaming/stracer/ToBytesOf.scala
@@ -3,9 +3,10 @@ package com.evolutiongaming.stracer
 import cats.data.{NonEmptyList => Nel}
 import cats.effect.Sync
 import com.evolutiongaming.skafka.{ToBytes, Topic}
-import com.evolutiongaming.stracer.compat.CollectionConverters._
 import zipkin2.codec.SpanBytesEncoder
 
+import scala.jdk.CollectionConverters.*
+
 object ToBytesOf {
 
   def apply[F[_]: Sync](encode: SpanBytesEncoder): ToBytes[F, Nel[SpanRecord]] = {
diff --git a/stracer/src/main/scala-2.12/com/evolutiongaming/stracer/compat.scala b/stracer/src/main/scala-2.12/com/evolutiongaming/stracer/compat.scala
diff --git a/stracer/src/main/scala-2.13/com/evolutiongaming/stracer/compat.scala b/stracer/src/main/scala-2.13/com/evolutiongaming/stracer/compat.scala
diff --git a/stracer/src/main/scala/com/evolutiongaming/stracer/HighLow.scala b/stracer/src/main/scala/com/evolutiongaming/stracer/HighLow.scala
@@ -1,21 +1,14 @@
 package com.evolutiongaming.stracer
 
 import com.evolutiongaming.stracer.hex.{FromHex, ToHex}
-import scodec.codecs
+import scodec.*
+import scodec.codecs.*
 
 final case class HighLow(high: Long, low: Long)
 
 object HighLow {
 
-  private val HighLowCodec = {
-    val codec = codecs.int64 ~ codecs.int64
-
-    val to = (a: (Long, Long)) => {
-      val (high, low) = a
-      HighLow(high = high, low = low)
-    }
-    codec.xmap[HighLow](to, a => (a.high, a.low))
-  }
+  private val HighLowCodec = (int64 :: int64).as[HighLow]
 
   implicit val HighLowToHex: ToHex[HighLow] = ToHex.fromEncoder(HighLowCodec)
 
diff --git a/stracer/src/main/scala/com/evolutiongaming/stracer/util/FromConfigReaderResult.scala b/stracer/src/main/scala/com/evolutiongaming/stracer/util/FromConfigReaderResult.scala
@@ -1,13 +1,15 @@
 package com.evolutiongaming.stracer.util
 
-import cats.syntax.all._
+import cats.syntax.all.*
 import com.evolutiongaming.catshelper.ApplicativeThrowable
 import pureconfig.ConfigReader
 import pureconfig.error.ConfigReaderException
 
+import scala.reflect.ClassTag
+
 trait FromConfigReaderResult[F[_]] {
 
-  def apply[A](a: ConfigReader.Result[A]): F[A]
+  def apply[A: ClassTag](a: ConfigReader.Result[A]): F[A]
 }
 
 object FromConfigReaderResult {
@@ -19,7 +21,7 @@ object FromConfigReaderResult {
 
   implicit def lift[F[_]: ApplicativeThrowable]: FromConfigReaderResult[F] = {
     new FromConfigReaderResult[F] {
-      def apply[A](a: ConfigReader.Result[A]) = {
+      def apply[A: ClassTag](a: ConfigReader.Result[A]): F[A] = {
         a.fold(a => ConfigReaderException(a).raiseError[F, A], _.pure[F])
       }
     }
diff --git a/stracer/src/main/scala/com/evolutiongaming/stracer/util/PureConfigHelper.scala b/stracer/src/main/scala/com/evolutiongaming/stracer/util/PureConfigHelper.scala
@@ -2,9 +2,11 @@ package com.evolutiongaming.stracer.util
 
 import pureconfig.ConfigReader
 
+import scala.reflect.ClassTag
+
 object PureConfigHelper {
 
-  implicit class ConfigReaderResultOpsPureConfigHelper[A](val self: ConfigReader.Result[A]) extends AnyVal {
+  implicit class ConfigReaderResultOpsPureConfigHelper[A: ClassTag](val self: ConfigReader.Result[A]) {
 
     def liftTo[F[_]: FromConfigReaderResult]: F[A] = FromConfigReaderResult[F].apply(self)
   }
diff --git a/stracer/src/test/scala/com/evolutiongaming/stracer/IOSuite.scala b/stracer/src/test/scala/com/evolutiongaming/stracer/IOSuite.scala
@@ -1,6 +1,7 @@
 package com.evolutiongaming.stracer
 
 import cats.effect.IO
+import cats.effect.unsafe.IORuntime
 import org.scalatest.Succeeded
 
 import scala.concurrent.Future
@@ -9,7 +10,7 @@ import scala.concurrent.duration._
 object IOSuite {
   val Timeout: FiniteDuration = 5.seconds
 
-  implicit val runtime = cats.effect.unsafe.IORuntime.global
+  implicit val runtime: IORuntime = cats.effect.unsafe.IORuntime.global
 
   def runIO[A](io: IO[A], timeout: FiniteDuration = Timeout): Future[Succeeded.type] =
     io.timeout(timeout).as(Succeeded).unsafeToFuture()
diff --git a/stracer/src/test/scala/com/evolutiongaming/stracer/TracerSpec.scala b/stracer/src/test/scala/com/evolutiongaming/stracer/TracerSpec.scala
diff --git a/version.sbt b/version.sbt

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-sbt.version=1.10.2`
	`1`	`+sbt.version=1.11.6`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ object ReportSpanRecord {`
`38`	`38`	`producerConfig <- config.getOpt[Config]("kafka.producer").map(ProducerConfig(_))`
`39`	`39`	`} yield {`
`40`	`40`	`val topic = config.getOpt[String]("topic") getOrElse "jaeger"`
`41`		`- implicit val toBytes = ToBytesOf(SpanBytesEncoder.THRIFT)`
	`41`	`+ implicit val toBytes: ToBytes[F, Nel[SpanRecord]] = ToBytesOf(SpanBytesEncoder.THRIFT)`
`42`	`42`	`of[F](topic, producerConfig, enabled, producerOf)`
`43`	`43`	`}`
`44`	`44`