Add support calling reusable workflow

ingemaradahl · ingemaradahl · commit 4dd08af9b701 · 2025-09-16T09:53:46.000+02:00
diff --git a/src/main/scala/sbtghactions/GenerativePlugin.scala b/src/main/scala/sbtghactions/GenerativePlugin.scala
@@ -37,6 +37,14 @@ object GenerativePlugin extends AutoPlugin {
     type WorkflowStep = sbtghactions.WorkflowStep
     val WorkflowStep = sbtghactions.WorkflowStep
 
+    type WorkflowAction = sbtghactions.WorkflowAction
+
+    type WorkflowSteps = sbtghactions.WorkflowSteps
+    val WorkflowSteps = sbtghactions.WorkflowSteps
+
+    type WorkflowApply = sbtghactions.WorkflowApply
+    val WorkflowApply = sbtghactions.WorkflowApply
+
     type RefPredicate = sbtghactions.RefPredicate
     val RefPredicate = sbtghactions.RefPredicate
 
@@ -73,6 +81,9 @@ object GenerativePlugin extends AutoPlugin {
     type Concurrency = sbtghactions.Concurrency
     val Concurrency = sbtghactions.Concurrency
 
+    type Secrets = sbtghactions.Secrets
+    val Secrets = sbtghactions.Secrets
+
     type Graalvm = sbtghactions.Graalvm
     val Graalvm = sbtghactions.Graalvm
   }
@@ -187,6 +198,12 @@ object GenerativePlugin extends AutoPlugin {
         s"concurrency: ${wrap(concurrency.group)}"
     }
 
+  def compileSecrets(secrets: Secrets): String =
+    secrets match {
+      case Secrets.Inherit => "secrets: inherit"
+      case Secrets.Explicit(secretMap) => compileEnv(secretMap, "secrets")
+    }
+
   def compileEnvironment(environment: JobEnvironment): String =
     environment.url match {
       case Some(url) =>
@@ -355,6 +372,8 @@ ${indent(rendered.mkString("\n"), 1)}"""
 
 
   def compileJob(job: WorkflowJob, sbt: String): String = {
+    val renderedName = s"""name: ${wrap(job.name)}"""
+
     val renderedNeeds = if (job.needs.isEmpty)
       ""
     else
@@ -485,24 +504,59 @@ ${indent(rendered.mkString("\n"), 1)}"""
 
     val declareShell = job.oses.exists(_.contains("windows"))
 
-    val runsOn = if (job.runsOnExtraLabels.isEmpty)
-      s"$${{ matrix.os }}"
-    else
-      job.runsOnExtraLabels.mkString(s"""[ "$${{ matrix.os }}", """, ", ", " ]" )
+    val runsOn = job.action match {
+      case steps: WorkflowSteps if steps.runsOnExtraLabels.isEmpty =>
+        "\nruns-on: ${{ matrix.os }}"
+      case steps: WorkflowSteps =>
+          steps.runsOnExtraLabels.mkString(s"""\nruns-on: [ "$${{ matrix.os }}", """, ", ", " ]")
+      case _ =>
+        ""
+    }
 
     val renderedFailFast = job.matrixFailFast.fold("")("\n  fail-fast: " + _)
 
-    val body = s"""name: ${wrap(job.name)}${renderedNeeds}${renderedCond}
-strategy:${renderedFailFast}
+    val renderedStrategy = s"""\nstrategy:${renderedFailFast}
   matrix:
     os:${compileList(job.oses, 3)}
     scala:${compileList(job.scalas, 3)}
-    java:${compileList(job.javas.map(_.render), 3)}${renderedMatrices}
-runs-on: ${runsOn}${renderedEnvironment}${renderedContainer}${renderedTimeout}${renderedPerm}${renderedEnv}${renderedConcurrency}
-steps:
-${indent(job.steps.map(compileStep(_, sbt, job.sbtStepPreamble, declareShell = declareShell)).mkString("\n\n"), 1)}"""
+    java:${compileList(job.javas.map(_.render), 3)}"""
+
+    val renderedSteps = job.action match {
+      case steps: WorkflowSteps =>
+        "\nsteps:\n" +
+          indent(steps.steps.map(compileStep(_, sbt, steps.sbtStepPreamble, declareShell = declareShell)).mkString("\n\n"), 1)
+      case _ =>
+        ""
+    }
+
+    val renderedUses = job.action match {
+      case apply: WorkflowApply =>
+        val renderedSecrets =
+          apply.secrets.map(compileSecrets).map("\n" + _).getOrElse("")
+
+        s"\nuses: ${apply.ref}${renderParams(apply.params)}${renderedSecrets}"
+      case _ =>
+        ""
+    }
 
-    s"${job.id}:\n${indent(body, 1)}"
+    val content = List(
+      renderedName,
+      renderedNeeds,
+      renderedCond,
+      renderedStrategy,
+      renderedMatrices,
+      runsOn,
+      renderedEnvironment,
+      renderedContainer,
+      renderedTimeout,
+      renderedPerm,
+      renderedEnv,
+      renderedConcurrency,
+      renderedSteps,
+      renderedUses,
+    ).reduce(_ ++ _)
+
+    s"${job.id}:\n${indent(content, 1)}"
   }
 
   def compileWorkflow(
diff --git a/src/main/scala/sbtghactions/Secrets.scala b/src/main/scala/sbtghactions/Secrets.scala
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2020-2021 Daniel Spiewak
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package sbtghactions
+
+sealed trait Secrets extends Product with Serializable
+
+object Secrets {
+  case object Inherit extends Secrets
+  case class Explicit(secrets: Map[String, String]) extends Secrets
+}
diff --git a/src/main/scala/sbtghactions/WorkflowAction.scala b/src/main/scala/sbtghactions/WorkflowAction.scala
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2020-2021 Daniel Spiewak
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package sbtghactions
+
+sealed trait WorkflowAction
+
+final case class WorkflowSteps(
+  steps: List[WorkflowStep],
+  sbtStepPreamble: List[String] = List(),
+  runsOnExtraLabels: List[String] = List(),
+) extends WorkflowAction
+
+
+final case class WorkflowApply(
+  ref: String,
+  params: Map[String, String] = Map.empty,
+  secrets: Option[Secrets] = None,
+) extends WorkflowAction
diff --git a/src/main/scala/sbtghactions/WorkflowJob.scala b/src/main/scala/sbtghactions/WorkflowJob.scala
@@ -19,6 +19,28 @@ package sbtghactions
 import scala.concurrent.duration.FiniteDuration
 
 final case class WorkflowJob(
+    id: String,
+    name: String,
+    action: WorkflowAction,
+    cond: Option[String],
+    permissions: Option[Permissions],
+    env: Map[String, String],
+    oses: List[String],
+    scalas: List[String],
+    javas: List[JavaSpec],
+    needs: List[String],
+    matrixFailFast: Option[Boolean],
+    matrixAdds: Map[String, List[String]],
+    matrixIncs: List[MatrixInclude],
+    matrixExcs: List[MatrixExclude],
+    container: Option[JobContainer],
+    environment: Option[JobEnvironment],
+    concurrency: Option[Concurrency],
+    timeout: Option[FiniteDuration],
+)
+
+object WorkflowJob {
+  def apply(
     id: String,
     name: String,
     steps: List[WorkflowStep],
@@ -38,4 +60,70 @@ final case class WorkflowJob(
     container: Option[JobContainer] = None,
     environment: Option[JobEnvironment] = None,
     concurrency: Option[Concurrency] = None,
-    timeout: Option[FiniteDuration] = None)
+    timeout: Option[FiniteDuration] = None
+  ): WorkflowJob =
+    WorkflowJob(
+      id,
+      name,
+      action = WorkflowSteps(steps, sbtStepPreamble, runsOnExtraLabels),
+      cond,
+      permissions,
+      env,
+      oses,
+      scalas,
+      javas,
+      needs,
+      matrixFailFast,
+      matrixAdds,
+      matrixIncs,
+      matrixExcs,
+      container,
+      environment,
+      concurrency,
+      timeout
+    )
+
+  def use(
+    id: String,
+    name: String,
+    ref: String,
+    params: Map[String, String] = Map.empty,
+    secrets: Option[Secrets] = None,
+    cond: Option[String] = None,
+    permissions: Option[Permissions] = None,
+    env: Map[String, String] = Map(),
+    oses: List[String] = List("ubuntu-latest"),
+    scalas: List[String] = List("2.13.10"),
+    javas: List[JavaSpec] = List(JavaSpec.zulu("8")),
+    needs: List[String] = List(),
+    matrixFailFast: Option[Boolean] = None,
+    matrixAdds: Map[String, List[String]] = Map(),
+    matrixIncs: List[MatrixInclude] = List(),
+    matrixExcs: List[MatrixExclude] = List(),
+    container: Option[JobContainer] = None,
+    environment: Option[JobEnvironment] = None,
+    concurrency: Option[Concurrency] = None,
+    timeout: Option[FiniteDuration] = None,
+    ): WorkflowJob =
+    WorkflowJob(
+      id,
+      name,
+      action = WorkflowApply(ref, params, secrets),
+      cond,
+      permissions,
+      env,
+      oses,
+      scalas,
+      javas,
+      needs,
+      matrixFailFast,
+      matrixAdds,
+      matrixIncs,
+      matrixExcs,
+      container,
+      environment,
+      concurrency,
+      timeout
+    )
+
+}
diff --git a/src/test/scala/sbtghactions/GenerativePluginSpec.scala b/src/test/scala/sbtghactions/GenerativePluginSpec.scala
