Improve project IDs naming

Author: arnaud-daroussin

.github/workflows/ci.yml

@@ -38,16 +38,16 @@ jobs:
     strategy:
       matrix:
         java: [11]
-        sbt-module: ['flink-common-api-1', 'flink-common-api-13', 'flink-1-api-1', 'flink-1-api-13']
+        sbt-module: ['flink-1-api-common', 'flink-1-api-common3', 'flink-1-api', 'flink-1-api3']
         include:
           - java: 21
-            sbt-module: 'flink-common-api-2'
+            sbt-module: 'flink-2-api-common'
           - java: 21
-            sbt-module: 'flink-common-api-23'
+            sbt-module: 'flink-2-api-common3'
           - java: 21
-            sbt-module: 'flink-2-api-2'
+            sbt-module: 'flink-2-api'
           - java: 21
-            sbt-module: 'flink-2-api-23'
+            sbt-module: 'flink-2-api3'
     env:
       JAVA_OPTIONS: '--add-opens java.base/java.lang=ALL-UNNAMED'
     steps:
@@ -61,13 +61,13 @@ jobs:
           java-version: ${{ matrix.java }}
           cache: sbt
       - name: Compile Scala 2.13 Docs
-        if: matrix.sbt-module == 'flink-1-api-1'
+        if: matrix.sbt-module == 'flink-1-api'
         run: JAVA_OPTS=$JAVA_OPTIONS sbt "docs/mdoc"
       - name: Compile Scala 3 Docs
-        if: matrix.sbt-module == 'flink-1-api-13'
+        if: matrix.sbt-module == 'flink-1-api3'
         run: JAVA_OPTS=$JAVA_OPTIONS sbt "docs3/mdoc"
       - name: Run tests on ${{ matrix.sbt-module }}
         run: JAVA_OPTS=$JAVA_OPTIONS sbt "project ${{ matrix.sbt-module }}; test"
       - name: Run tests on examples
-        if: matrix.sbt-module == 'flink-1-api-13'
+        if: matrix.sbt-module == 'flink-1-api3'
         run: JAVA_OPTS=$JAVA_OPTIONS sbt "project examples3; test"

build.sbt

@@ -1,5 +1,3 @@
-import FlinkAxis._
-
 Global / onChangedBuildSource := ReloadOnSourceChanges
 Global / excludeLintKeys      := Set(crossScalaVersions)
 
@@ -46,7 +44,7 @@ inThisBuild(
 
 lazy val `flink-scala-api` = (project in file("."))
   .aggregate(
-    `flink-common-api`.projectRefs ++
+    `flink`.projectRefs ++
       `flink-1-api`.projectRefs ++
       `flink-2-api`.projectRefs ++
       `examples`.projectRefs: _*
@@ -106,31 +104,32 @@ def flinkDependencies(flinkVersion: String) =
     "ch.qos.logback"    % "logback-classic"             % "1.5.32"     % Test
   )
 
-lazy val `flink-common-api` = (projectMatrix in file("modules/flink-common-api"))
+// val has to be named `flink` in order to generate `flink-1-api-common` and `flink-2-api-common` project ids
+lazy val `flink` = (projectMatrix in file("modules/flink-common-api"))
   .settings(commonSettings)
   .customRow(
     scalaVersions = crossVersions,
-    axisValues = Seq(Flink1, VirtualAxis.jvm),
+    axisValues = Seq(FlinkAxis.Flink1Common, VirtualAxis.jvm),
     settings = Seq(
       name := "flink-scala-api-common-1",
       libraryDependencies ++= flinkDependencies(flinkVersion1)
     )
   )
   .customRow(
     scalaVersions = crossVersions,
-    axisValues = Seq(Flink2, VirtualAxis.jvm),
+    axisValues = Seq(FlinkAxis.Flink2Common, VirtualAxis.jvm),
     settings = Seq(
       name := "flink-scala-api-common-2",
       libraryDependencies ++= flinkDependencies(flinkVersion2)
     )
   )
 
 lazy val `flink-1-api` = (projectMatrix in file("modules/flink-1-api"))
-  .dependsOn(`flink-common-api`)
+  .dependsOn(`flink`)
   .settings(commonSettings)
   .customRow(
     scalaVersions = crossVersions,
-    axisValues = Seq(Flink1, VirtualAxis.jvm),
+    axisValues = Seq(FlinkAxis.Flink1Api, VirtualAxis.jvm),
     settings = Seq(
       name := "flink-scala-api-1",
       libraryDependencies ++= (flinkDependencies(flinkVersion1) :+
@@ -139,11 +138,11 @@ lazy val `flink-1-api` = (projectMatrix in file("modules/flink-1-api"))
   )
 
 lazy val `flink-2-api` = (projectMatrix in file("modules/flink-2-api"))
-  .dependsOn(`flink-common-api`)
+  .dependsOn(`flink`)
   .settings(commonSettings)
   .customRow(
     scalaVersions = crossVersions,
-    axisValues = Seq(Flink2, VirtualAxis.jvm),
+    axisValues = Seq(FlinkAxis.Flink2Api, VirtualAxis.jvm),
     settings = Seq(
       name := "flink-scala-api-2",
       libraryDependencies ++= flinkDependencies(flinkVersion2)

project/FlinkAxis.scala

@@ -1,10 +1,21 @@
 // Custom axis for Flink major version
-case class FlinkAxis(flinkMajor: String) extends sbt.VirtualAxis.WeakAxis {
+case class FlinkAxis(flinkMajor: String, suffix: String) extends sbt.VirtualAxis.WeakAxis {
   override def directorySuffix: String = s"-flink$flinkMajor"
-  override def idSuffix: String        = s"-$flinkMajor"
+  override def idSuffix: String        = suffix
+
+  // Took example on sbt.VirtualAxis.ScalaVersionAxis: use only the flinkMajor field for equality
+  override def equals(obj: Any): Boolean = obj match {
+    case value: AnyRef if this eq value => true
+    case o: FlinkAxis                   => this.flinkMajor == o.flinkMajor
+    case _                              => false
+  }
+
+  override def hashCode: Int = 37 * (17 + "FlinkAxis".hashCode()) + flinkMajor.hashCode()
 }
 
 object FlinkAxis {
-  val Flink1 = FlinkAxis("1")
-  val Flink2 = FlinkAxis("2")
+  val Flink1Common = FlinkAxis("1", "-1-api-common")
+  val Flink2Common = FlinkAxis("2", "-2-api-common")
+  val Flink1Api = FlinkAxis("1", "")
+  val Flink2Api = FlinkAxis("2", "")
 }