Actually run Scala Steward - given that generating config succeeded

Author: rtyley

.github/workflows/generate-targeted-prs.yml

@@ -23,13 +23,11 @@ jobs:
           TARGETED_RELEASES_GITHUB_APP_CLIENT_ID: 214238
           TARGETED_RELEASES_GITHUB_APP_PRIVATE_KEY: ${{ secrets.SCALA_STEWARD_APP_PRIVATE_KEY }}
         run: sbt "run ${{ inputs.target_pr }} targeted-scala-steward.conf"
-      - name: Pretend to run Scala Steward
-        run: echo "Hi there!"
-#      - name: Execute Scala Steward
-#        uses: scala-steward-org/scala-steward-action@v2.76.0
-#        with:
-#          github-app-id: 214238
-#          github-app-installation-id: 26822732
-#          github-app-key: ${{ secrets.SCALA_STEWARD_APP_PRIVATE_KEY }}
-#          repo-config: targeted-scala-steward.conf
-#          other-args: "--add-labels"
+      - name: Execute Scala Steward
+        uses: scala-steward-org/scala-steward-action@v2.76.0
+        with:
+          github-app-id: 214238
+          github-app-installation-id: 26822732
+          github-app-key: ${{ secrets.SCALA_STEWARD_APP_PRIVATE_KEY }}
+          repo-config: targeted-scala-steward.conf
+          other-args: "--add-labels"

build.sbt

@@ -1,6 +1,9 @@
 scalaVersion := "3.3.6"
 scalacOptions := Seq("-deprecation", "-release:21")
 
-libraryDependencies += "com.madgag.play-git-hub" %% "core" % "10.0.0-PREVIEW.examine-default-branch.2025-10-01T1252.5ed70273"
+libraryDependencies ++= Seq(
+  "com.madgag.play-git-hub" %% "core" % "10.0.0-PREVIEW.examine-default-branch.2025-10-01T1252.5ed70273",
+  "org.scalatest" %% "scalatest" % "3.2.19" % Test
+)
 
 Compile / run / fork := true

…rgeted/WriteConfigToTargetArtefact.scala …WriteConfigTargetingPreviewRelease.scalasrc/main/scala/com/gu/scalasteward/targeted/WriteConfigToTargetArtefact.scala renamed to src/main/scala/com/gu/scalasteward/targeted/WriteConfigTargetingPreviewRelease.scala src/main/scala/com/gu/scalasteward/targeted/WriteConfigToTargetArtefact.scala renamed to src/main/scala/com/gu/scalasteward/targeted/WriteConfigTargetingPreviewRelease.scala

@@ -5,40 +5,35 @@ import cats.data.*
 import cats.effect.unsafe.implicits.global
 import cats.effect.{ExitCode, IO, IOApp}
 import cats.implicits.*
-import cats.syntax.all.*
 import com.gu.scalasteward.targeted.model.{Artifact, Config}
 import com.madgag.github.apps.GitHubAppAuth
 import com.madgag.scalagithub
 import com.madgag.scalagithub.GitHub
 import com.madgag.scalagithub.model.{Comment, PullRequest, RepoId}
-import play.api.libs.json.Json.toJson
-import play.api.libs.json.{Json, OWrites}
 import sttp.model.*
 
 import java.nio.file.{Files, Path}
 import scala.collection.immutable.SortedSet
 import scala.concurrent.ExecutionContext.Implicits.global
 
-val gitHubAppAuth: GitHubAppAuth = GitHubAppAuth.fromConfigMap(sys.env, "TARGETED_RELEASES")
+object WriteConfigTargetingPreviewRelease extends IOApp {
+  val gitHubAppAuth: GitHubAppAuth = GitHubAppAuth.fromConfigMap(sys.env, "TARGETED_RELEASES")
 
-object HelloWorld extends IOApp {
-
-  def run(args: List[String]) = {
+  def run(args: List[String]): IO[ExitCode] = {
     val prId = PullRequest.Id.from(Uri.unsafeParse(args(0)))
     val outputFile = Path.of(args(1))
     for {
       installationAccess <- gitHubAppAuth.accessSoleInstallation()
-      _ <- IO.println(s"Hello, ${installationAccess.installedOnAccount.atLogin}!")
       given GitHub = installationAccess.accountAccess().gitHub
       pr <- summon[GitHub].getPullRequest(prId).map(_.result)
       configOpt <- scalaStewardConfigForMostRecentPreviewReleaseOf(pr).value
       exitCode <- IO {
         configOpt.fold {
-          Console.err.println(s"Couldn't generate config for ${pr.html_url}")
+          Console.err.println(s"Could not generate config for ${pr.html_url}")
           ExitCode.Error
         } { config =>
           Files.writeString(outputFile, config.text)
-          println(s"Wrote config to ${outputFile.toAbsolutePath}")
+          println(s"Wrote config to ${outputFile.toAbsolutePath} :\n\n${config.text}")
           ExitCode.Success
         }
       }
@@ -54,13 +49,14 @@ object HelloWorld extends IOApp {
   def findPreviewVersionIn(comment: Comment): Option[String] = comment.body.linesIterator.find(_.contains("-PREVIEW"))
 
   def tagMessageFor(repoId: RepoId, version: String)(using g: GitHub): IO[String] = for {
+    _ <- IO.println(s"Looking for '${repoId.fullName}' release tag: $version")
     repo <- g.getRepo(repoId).map(_.result)
     ref <- repo.refs.get(s"tags/v$version").map(_.result)
     tag <- repo.tags.get(ref.objectId.name).map(_.result)
   } yield tag.message
 
   def artifactsFrom(tagMessage: String): Seq[Artifact] =
-    tagMessage.linesIterator.filter(_.endsWith(".pom")).flatMap(Artifact.fromSha256PomLine).toSeq
+    tagMessage.linesIterator.filter(_.endsWith(".pom")).flatMap(Artifact.fromHashdeepPomLine).toSeq
 
   def scalaStewardConfigFor(pr: PullRequest, version: String)(using GitHub): OptionT[IO, Config] = OptionT(for {
     tagMessage <- tagMessageFor(pr.prId.repo, version)

src/main/scala/com/gu/scalasteward/targeted/model/Artifact.scala

@@ -4,8 +4,19 @@ import cats.Order
 import play.api.libs.json.{Json, OWrites}
 
 object Artifact {
-  // c96c2303d065496792e7edb379b0e671f57edbb13cecb6b2d94deb22d1a504d4  ./com/gu/panda-hmac-core_3/11.0.0/panda-hmac-core_3-11.0.0.pom
-  def fromSha256PomLine(pomLine: String): Option[Artifact] = {
+  /**
+   * Parses a single line from the HashDeep (https://github.com/jessek/hashdeep) output included in
+   * the annotated Git Tag message for a release by our Scala Library Release workflow:
+   *
+   * https://github.com/guardian/gha-scala-library-release-workflow/blob/fa09703460a2eae0fd7d47b3f3088b34c400f973/actions/sign/action.yml#L106-L110
+   *
+   * An example line would look like this:
+   *
+   * `c96c2303d065496792e7edb379b0e671f57edbb13cecb6b2d94deb22d1a504d4  ./com/gu/panda-hmac-core_3/11.0.0/panda-hmac-core_3-11.0.0.pom`
+   *
+   * We only want to extract the groupId, artifactId & version (not the hash).
+   */
+  def fromHashdeepPomLine(pomLine: String): Option[Artifact] = {
     val segments = pomLine.split(' ').last.split('/').drop(1).dropRight(1).reverse.toList
     segments match {
       case version :: artifactId :: groupSegments =>
@@ -14,7 +25,7 @@ object Artifact {
     }
   }
 
-  given Order[Artifact] = Order.by(Tuple.fromProductTyped)
+  given Order[Artifact] = Order.by(Tuple.fromProductTyped) // required by NonEmptySet
 
   given OWrites[Artifact] = Json.writes
 }

src/main/scala/com/gu/scalasteward/targeted/model/Config.scala

@@ -9,9 +9,6 @@ case class Config(
   pr: PullRequest,
   updates: NonEmptySet[Artifact]
 ) {
-  val groupIds: NonEmptySet[String] = updates.map(_.groupId)
-  val versions: NonEmptySet[String] = updates.map(_.version)
-
   val commitsMessage: String = "Update ${artifactName} from ${currentVersion} to ${nextVersion}"
 
   val updatesJson: String = toJson(updates.toSortedSet.toSeq).toString

src/test/scala/com/gu/scalasteward/targeted/model/ArtifactTest.scala

@@ -0,0 +1,20 @@
+package com.gu.scalasteward.targeted.model
+
+import org.scalatest.OptionValues
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+class ArtifactTest extends AnyFlatSpec with Matchers with OptionValues {
+  it should "read artifact coordinates from a hashdeep line, as written by gha-scala-library-release-workflow" in {
+    Artifact.fromHashdeepPomLine("c96c2303d065496792e7edb379b0e671f57edbb13cecb6b2d94deb22d1a504d4  ./com/gu/panda-hmac-core_3/11.0.0/panda-hmac-core_3-11.0.0.pom").value shouldBe
+      Artifact("com.gu", "panda-hmac-core_3", "11.0.0")
+  }
+
+  it should "remove the Scala version from the artifact id" in {
+    Artifact("com.gu", "panda-hmac-core_3", "11.0.0").artifactIdWithoutScalaOrSbtVersion shouldBe "panda-hmac-core"
+  }
+
+  it should "remove the Scala & sbt version from a sbt plugin artifact" in {
+    Artifact("com.gu", "sbt-scrooge-typescript_2.12_1.0", "4.0.0").artifactIdWithoutScalaOrSbtVersion shouldBe "sbt-scrooge-typescript"
+  }
+}