Publishing

Author: MateuszKubuszok

.github/workflows/ci.yml

@@ -41,17 +41,13 @@ jobs:
           - "3.8.2"
     name: Test on Scala ${{ matrix.scala }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
+      - uses: actions/checkout@v6
         with:
-          distribution: temurin
-          java-version: 17
-          cache: sbt
-      - name: Install sbt
-        run: |
-          echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | sudo tee /etc/apt/sources.list.d/sbt.list
-          curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" | sudo apt-key add
-          sudo apt-get update
-          sudo apt-get install -y sbt
+          fetch-depth: 0
+      - uses: coursier/cache-action@v8
+      - uses: coursier/setup-action@v3.0.0
+        with:
+          jvm: "temurin:1.17.0.15"
+          apps: sbt
       - name: Run tests
         run: sbt "++${{ matrix.scala }}; tests/test"

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Sonatype Release
+
+on:
+  push:
+    branches: [master]
+    tags: ["*"]
+
+jobs:
+  release-tag:
+    runs-on: ubuntu-latest
+
+    name: ${{ startsWith(github.ref, 'refs/tags/') && 'Publish Tag as Release' || 'Publish Snapshot' }}
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: coursier/cache-action@v8
+      - name: Import GPG key for signing the release
+        uses: crazy-max/ghaction-import-gpg@v7
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.GPG_PASSPHRASE }}
+      - uses: coursier/setup-action@v3.0.0
+        with:
+          jvm: "temurin:1.17.0.15"
+          apps: sbt
+      - name: Publish all projects
+        run: sbt ci-release
+        env:
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}

build.sbt

@@ -1,3 +1,10 @@
+import com.jsuereth.sbtpgp.PgpKeys.publishSigned
+
+// Used to publish snapshots to Maven Central.
+val mavenCentralSnapshots = "Maven Central Snapshots" at "https://central.sonatype.com/repository/maven-snapshots"
+
+// Versions:
+
 val scala2_13 = "2.13.16"
 
 val scala3Versions = Seq(
@@ -13,18 +20,75 @@ val scala3Latest = scala3Versions.last
 
 val newtypeVersion = "0.4.4"
 
-ThisBuild / organization := "com.kubuszok"
-ThisBuild / versionScheme := Some("early-semver")
+// Common settings:
+
+val publishSettings = Seq(
+  organization := "com.kubuszok",
+  homepage := Some(url("https://github.com/MateuszKubuszok/scala-newtype-compat")),
+  organizationHomepage := Some(url("https://kubuszok.com")),
+  licenses := Seq("Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0")),
+  scmInfo := Some(
+    ScmInfo(
+      url("https://github.com/MateuszKubuszok/scala-newtype-compat/"),
+      "scm:git:git@github.com:MateuszKubuszok/scala-newtype-compat.git"
+    )
+  ),
+  startYear := Some(2026),
+  developers := List(
+    Developer("MateuszKubuszok", "Mateusz Kubuszok", "", url("https://github.com/MateuszKubuszok"))
+  ),
+  pomExtra := (
+    <issueManagement>
+      <system>GitHub issues</system>
+      <url>https://github.com/MateuszKubuszok/scala-newtype-compat/issues</url>
+    </issueManagement>
+  ),
+  publishTo := {
+    if (isSnapshot.value) Some(mavenCentralSnapshots)
+    else localStaging.value
+  },
+  publishMavenStyle := true,
+  Test / publishArtifact := false,
+  pomIncludeRepository := {
+    _ => false
+  },
+  versionScheme := Some("early-semver"),
+  git.useGitDescribe := true,
+  git.uncommittedSignifier := None,
+  // Sonatype ignores isSnapshot setting and only looks at -SNAPSHOT suffix in version:
+  //   https://central.sonatype.org/publish/publish-maven/#performing-a-snapshot-deployment
+  // meanwhile sbt-git used to set up SNAPSHOT if there were uncommitted changes:
+  //   https://github.com/sbt/sbt-git/issues/164
+  // (now this suffix is empty by default) so we need to fix it manually.
+  git.gitUncommittedChanges := git.gitCurrentTags.value.isEmpty,
+  git.uncommittedSignifier := Some("SNAPSHOT")
+)
+
+val noPublishSettings =
+  Seq(publish / skip := true, publishArtifact := false)
+
+// Modules:
 
 lazy val root = project
   .in(file("."))
+  .enablePlugins(GitVersioning, GitBranchPrompt)
+  .settings(publishSettings)
+  .settings(noPublishSettings)
   .settings(
-    publish / skip := true,
-    crossScalaVersions := Nil
+    name := "scala-newtype-compat-root",
+    crossScalaVersions := Nil,
+    commands += Command.command("ci-release") { state =>
+      val extracted = Project.extract(state)
+      val tags = extracted.get(git.gitCurrentTags)
+      val cmd = if (tags.nonEmpty) "publishSigned ; sonaRelease" else "publishSigned"
+      cmd :: state
+    }
   )
   .aggregate(compat, plugin, tests)
 
 lazy val compat = project
+  .enablePlugins(GitVersioning, GitBranchPrompt)
+  .settings(publishSettings)
   .settings(
     name := "newtype-compat",
     crossScalaVersions := scala2_13 +: scala3Versions,
@@ -36,6 +100,8 @@ lazy val compat = project
   )
 
 lazy val plugin = project
+  .enablePlugins(GitVersioning, GitBranchPrompt)
+  .settings(publishSettings)
   .settings(
     name := "newtype-plugin",
     crossScalaVersions := scala3Versions,
@@ -45,9 +111,11 @@ lazy val plugin = project
 
 lazy val tests = project
   .dependsOn(compat)
+  .enablePlugins(GitVersioning, GitBranchPrompt)
+  .settings(publishSettings)
+  .settings(noPublishSettings)
   .settings(
     name := "newtype-compat-tests",
-    publish / skip := true,
     crossScalaVersions := scala2_13 +: scala3Versions,
     scalaVersion := scala3Latest,
     scalacOptions ++= {

project/build.properties

@@ -1 +1 @@
-sbt.version=1.10.11
+sbt.version=1.12.6

project/plugins.sbt

@@ -1 +1,4 @@
-addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.9.2")
+// git
+addSbtPlugin("com.github.sbt" % "sbt-git" % "2.1.0")
+// publishing
+addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.3.1")