Simplify Mill cross-build to only include major version (#5098)

This simplifies commands from, e.g. `mill chisel[2.13.18].compile` to
just `mill chisel[2.13].compile`. This makes it such that we no longer
have to change CI and documentation whenever we add support for a new
minor version of Scala.

Author: jackkoenig

.github/workflows/ci-circt-nightly.yml

@@ -49,7 +49,7 @@ jobs:
       matrix:
         system: ["ubuntu-24.04"]
         jvm: [21]
-        scala: ["2.13.18"]
+        scala: ["2.13"]
         espresso: ["2.4"]
         slang: ["7.0"]
         circt: ["nightly"]

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
       matrix:
         system: ["ubuntu-24.04"]
         jvm: [21]
-        scala: ["2.13.18"]
+        scala: ["2.13"]
         espresso: ["2.4"]
         slang: ["7.0"]
     uses: ./.github/workflows/test.yml

.github/workflows/test.yml

@@ -15,7 +15,7 @@ on:
         type: number
       scala:
         description: 'The Scala version to use'
-        default: '2.13.18'
+        default: '2.13'
         required: true
         type: string
       espresso:
@@ -265,7 +265,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        scala: ["2.13.18"]
+        scala: ["2.13"]
     steps:
       - name: Checkout
         uses: actions/checkout@v5

CONTRIBUTING.md

@@ -81,7 +81,7 @@ Most testing can be done on just the Chisel build unit:
 ```
 
 The `[]` exists because we are cross-compiling between Scala 2.13 and Scala 3.
-You can pick a specific version, e.g. `./mill chisel[2.13.18]`.
+You can pick a specific version, e.g. `./mill chisel[2.13]`.
 Using `[]` will pick the first version in the list of supported versions which one can think about as the "default" version.
 
 You can test everything with:

benchmark/package.mill

@@ -8,8 +8,8 @@ import mill.contrib.jmh.JmhModule
 import build._
 
 object `package` extends ScalaModule with JmhModule with ScalafmtModule {
-  def scalaVersion = v.scalaVersion
+  def scalaVersion = v.defaultScalaVersion
   def jmhCoreVersion = v.jmhVersion
 
-  override def moduleDeps = Seq(chisel(v.scalaVersion))
+  override def moduleDeps = Seq(chisel(v.scalaVersionToCross(v.defaultScalaVersion)))
 }

build.mill

@@ -14,6 +14,12 @@ import mill.scalalib.scalafmt._
 
 object v extends Module {
 
+  // Add support for later Scala 2.13 by bumping this.
+  val scala213MinorVersion: Int = 18
+
+  // Bump Scala 3 version by bumping this.
+  val scala3MinorVersion: String = "3.4"
+
   val javaVersion = {
     val rawVersion = sys.props("java.specification.version")
     // Older versions of Java started with 1., e.g. 1.8 == 8
@@ -32,20 +38,26 @@ object v extends Module {
   // Only publish plugin for 2.13.11+ when using Java > 11, but still
   // publish all versions when Java version <= 11.
   val pluginScalaCrossVersions = {
-    val latest213 = 18
     val java21Min213 = 11
     val minVersion = if (javaVersion > 11) java21Min213 else 0
-    val versions = minVersion to latest213
+    val versions = minVersion to scala213MinorVersion
     val versionSeq = versions.map(v => s"2.13.$v").toSeq
-    versionSeq ++ Seq("3.3.4")
+    versionSeq :+ scalaCrossToVersion("3")
   }
 
-  val scalaCrossVersions = Seq(
-    "2.13.18",
-    "3.3.4"
-  )
+  val scalaCrossVersions = Seq("2.13", "3")
+
+  def scalaCrossToVersion(major: String): String = major match {
+    case "2.13" => s"2.13.$scala213MinorVersion"
+    case "3"    => s"3.$scala3MinorVersion"
+  }
+
+  def scalaVersionToCross(version: String): String =
+    if (version.startsWith("2.13")) "2.13"
+    else if (version.startsWith("3.")) "3"
+    else throw new Exception(s"Unsupported version $version")
 
-  def isScala3(ver: String): Boolean = ver.startsWith("3.")
+  def isScala3(ver: String): Boolean = ver.startsWith("3")
 
   def buildUnits(): Seq[ScalaModule] = {
     scalaCrossVersions.flatMap { ver =>
@@ -65,7 +77,10 @@ object v extends Module {
     }
   }
 
-  val scalaVersion = scalaCrossVersions.head
+  def defaultCrossVersion = scalaCrossVersions.head
+
+  def defaultScalaVersion = scalaCrossToVersion(defaultCrossVersion)
+
   val jmhVersion = "1.37"
   val osLib = mvn"com.lihaoyi::os-lib:0.10.7" // 0.11 requires Java 11
   val upickle = mvn"com.lihaoyi::upickle:3.3.1" // upickle 4.0 requires Scala 3.4 (we target Scala 3.3 LTS)
@@ -181,6 +196,15 @@ def latestStableVersion() = Task.Command {
   docs.latestStableVersion()
 }
 
+/** Our base trait that helps with our simplified cross versioning (2.13 instead of 2.13.18)
+  *
+  * Keep this lean, it's mixed in to firrtl and svsim as well.
+  */
+trait ChiselCrossModule extends CrossSbtModule {
+  protected def _scalaVersion = v.scalaCrossToVersion(crossScalaVersion)
+  def scalaVersion = _scalaVersion
+}
+
 trait HasScala2MacroAnno extends CrossModuleBase {
   override def scalacOptions = Task {
     if (!v.isScala3(crossScalaVersion)) {
@@ -189,9 +213,10 @@ trait HasScala2MacroAnno extends CrossModuleBase {
   }
 }
 
-trait HasScalaPlugin extends CrossModuleBase {
+trait HasScalaPlugin extends ChiselCrossModule {
   import build_.plugin.Plugin
-  def pluginModule: Plugin
+
+  def pluginModule: Plugin = plugin.cross(_scalaVersion)
 
   override def scalacOptions = Task {
     super.scalacOptions() ++ Seq(s"-Xplugin:${pluginModule.jar().path}")
@@ -271,10 +296,10 @@ object circt extends Module {
 object chisel extends Cross[Chisel](v.scalaCrossVersions)
 
 trait Chisel extends CrossSbtModule with HasScala2MacroAnno with HasScalaPlugin with ScalafmtModule {
+
   override def moduleDir = super.moduleDir / os.up
   def svsimModule = svsim.cross(crossScalaVersion)
   def coreModule = core.cross(crossScalaVersion)
-  def pluginModule = plugin.cross()
 
   override def scalacOptions = Task {
     if (v.isScala3(crossScalaVersion)) {

core/package.mill

@@ -12,8 +12,7 @@ object `package` extends Module {
   object cross extends Cross[Core](v.scalaCrossVersions)
 }
 
-trait Core extends CrossSbtModule with HasScala2MacroAnno with HasCommonOptions with ScalafmtModule {
-  def scalaVersion = crossScalaVersion
+trait Core extends ChiselCrossModule with HasScala2MacroAnno with HasCommonOptions with ScalafmtModule {
 
   def moduleDir = super.moduleDir / os.up
 

docs/package.mill

@@ -11,21 +11,19 @@ import mill.util.Jvm
 import build._
 
 /** MDoc project */
-object `package` extends SbtModule with HasScalaPlugin with HasCommonOptions {
+object `package` extends HasScalaPlugin with HasCommonOptions {
 
-  override def scalaVersion = v.scalaVersion
+  override def scalaVersion = v.defaultScalaVersion
 
   // This not really a CrossModule but HasScala2Plugin and HasCommonOptions require it
-  override def crossValue = v.scalaVersion
-
-  def pluginModule = plugin.cross()
+  override def crossValue = v.scalaCrossVersions.head
 
   // Our scala sources to be used by mdoc live here
   override def moduleDir = super.moduleDir / os.up / "docs-target"
 
   override def mvnDeps = Task { Seq(v.mdoc, v.scalatest) }
 
-  override def moduleDeps = Seq(chisel(v.scalaVersion))
+  override def moduleDeps = Seq(chisel(crossValue))
 
   // Suppress missing interpolator warnings because mdoc appears to introduce them.
   override def extraWarnConf = Seq("msg=possible missing interpolator:s")

firrtl/package.mill

@@ -12,13 +12,7 @@ object `package` extends Module {
   object cross extends Cross[Firrtl](v.scalaCrossVersions)
 }
 
-trait Firrtl
-    extends CrossSbtModule
-    with Cross.Module[String]
-    with HasScala2MacroAnno
-    with HasCommonOptions
-    with ScalafmtModule {
-  def scalaVersion = crossScalaVersion
+trait Firrtl extends ChiselCrossModule with HasScala2MacroAnno with HasCommonOptions with ScalafmtModule {
 
   def moduleDir = super.moduleDir / os.up
 

integration-tests/package.mill

@@ -12,15 +12,15 @@ object `package` extends Module {
   object cross extends Cross[IntegrationTests](v.scalaCrossVersions)
 }
 
-trait IntegrationTests extends CrossSbtModule with HasScalaPlugin with HasCommonOptions with ScalafmtModule {
-  def pluginModule = plugin.cross()
+trait IntegrationTests extends HasScalaPlugin with HasCommonOptions with ScalafmtModule {
+
   def moduleDir = super.moduleDir / os.up
 
   // TODO enable
   override def xsource3 = false
 
   object test extends CrossSbtTests with TestModule.ScalaTest with ScalafmtModule {
-    override def moduleDeps = super.moduleDeps :+ chisel().test
+    override def moduleDeps = super.moduleDeps :+ chisel(crossScalaVersion).test
     def mvnDeps = Seq(v.scalatest, v.scalacheck)
 
     override def testForkGrouping = discoveredTestClasses().grouped(8).toSeq