Merge pull request #4517 from sjrd/version-scheme

sjrd · web-flow · commit 46be6baadcfc · 2021-07-30T22:09:34.000+02:00
Fix #4513: Set up versionScheme for all the "library" artifacts.
diff --git a/project/Build.scala b/project/Build.scala
@@ -493,7 +493,7 @@ object Build {
       }
   )
 
-  val publishSettings = Seq(
+  private val basePublishSettings = Seq(
       publishMavenStyle := true,
       publishTo := {
         val nexus = "https://oss.sonatype.org/"
@@ -524,6 +524,35 @@ object Build {
       pomIncludeRepository := { _ => false }
   )
 
+  /** Constants for the `verScheme` parameter of `publishSettings`.
+   *
+   *  sbt does not define constants in its API for `versionScheme`. It
+   *  specifies some strings instead. We use the following version schemes,
+   *  depending on the artifacts and the versioning policy in `VERSIONING.md`:
+   *
+   *  - `"strict"` for artifacts whose public API can break in patch releases (e.g., `test-bridge`)
+   *  - `"pvp"` for artifacts whose public API can break in minor releases
+   *  - `"semver-spec"` for artifacts whose public API can only break in major releases (e.g., `library`)
+   *
+   *  At the moment, we only set the version scheme for artifacts in the
+   *  "library ecosystem", i.e., scalajs-library, scalajs-test-interface,
+   *  scalajs-junit-runtime and scalajs-test-bridge. Artifacts of the "tools
+   *  ecosystem" do not have a version scheme set, as the jury is still out on
+   *  what is the best way to specify them.
+   *
+   *  See also https://www.scala-sbt.org/1.x/docs/Publishing.html#Version+scheme
+   */
+  object VersionScheme {
+    final val BreakOnPatch = "strict"
+    final val BreakOnMinor = "pvp"
+    final val BreakOnMajor = "semver-spec"
+  }
+
+  def publishSettings(verScheme: Option[String]): Seq[Setting[_]] = Def.settings(
+    basePublishSettings,
+    versionScheme := verScheme,
+  )
+
   val fatalWarningsSettings = Def.settings(
       scalacOptions += "-Xfatal-warnings",
 
@@ -712,7 +741,7 @@ object Build {
 
   val commonIrProjectSettings = Def.settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js IR",
       previousArtifactSetting,
@@ -748,7 +777,7 @@ object Build {
       id = "compiler", base = file("compiler")
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js compiler",
       crossVersion := CrossVersion.full, // because compiler api is not binary compatible
@@ -801,7 +830,7 @@ object Build {
 
   val commonLinkerInterfaceSettings = Def.settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js linker interface",
 
@@ -889,7 +918,7 @@ object Build {
 
   def commonLinkerSettings(library: LocalProject) = Def.settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js linker",
       ensureSAMSupportSetting,
@@ -1052,7 +1081,7 @@ object Build {
       id = "testAdapter", base = file("test-adapter")
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js sbt test adapter",
       libraryDependencies ++= Seq(
@@ -1072,7 +1101,7 @@ object Build {
   lazy val plugin: Project = Project(id = "sbtPlugin", base = file("sbt-plugin"))
       .enablePlugins(ScriptedPlugin).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js sbt plugin",
       normalizedName := "sbt-scalajs",
@@ -1429,7 +1458,7 @@ object Build {
       MyScalaJSPlugin
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(Some(VersionScheme.BreakOnMajor)),
       crossVersion := CrossVersion.binary, // no _sjs suffix
       fatalWarningsSettings,
       name := "Scala.js library",
@@ -1549,7 +1578,7 @@ object Build {
       MyScalaJSPlugin
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(Some(VersionScheme.BreakOnMajor)),
       crossVersion := CrossVersion.binary, // no _sjs suffix
       fatalWarningsSettings,
       name := "Scala.js test interface",
@@ -1564,7 +1593,7 @@ object Build {
       MyScalaJSPlugin
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(Some(VersionScheme.BreakOnPatch)),
       crossVersion := CrossVersion.binary, // no _sjs suffix
       fatalWarningsSettings,
       name := "Scala.js test bridge",
@@ -1588,7 +1617,7 @@ object Build {
       MyScalaJSPlugin
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(Some(VersionScheme.BreakOnMajor)),
       crossVersion := CrossVersion.binary, // no _sjs suffix
       fatalWarningsSettings,
       name := "Scala.js JUnit test runtime",
@@ -1642,7 +1671,7 @@ object Build {
       id = "jUnitPlugin", base = file("junit-plugin")
   ).settings(
       commonSettings,
-      publishSettings,
+      publishSettings(None),
       fatalWarningsSettings,
       name := "Scala.js JUnit test plugin",
       crossVersion := CrossVersion.full,
