Merge pull request #732 from zarthross/with-more

Add more `with*`, `update*`, and `add*` for Workflow step and jobs.
typelevel · Aug 13, 2024 · e384990 · e384990
2 parents 56c0129 + ab4311b
commit e384990
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 20 deletions.
diff --git a/github-actions/mima.sbt b/github-actions/mima.sbt
@@ -1,23 +1,8 @@
 import com.typesafe.tools.mima.core._
 mimaBinaryIssueFilters ++= Seq(
-  "org.typelevel.sbt.gha.WorkflowJob.withId",
-  "org.typelevel.sbt.gha.WorkflowJob.withName",
-  "org.typelevel.sbt.gha.WorkflowJob.withSteps",
-  "org.typelevel.sbt.gha.WorkflowJob.withSbtStepPreamble",
-  "org.typelevel.sbt.gha.WorkflowJob.withCond",
-  "org.typelevel.sbt.gha.WorkflowJob.withPermissions",
-  "org.typelevel.sbt.gha.WorkflowJob.withEnv",
-  "org.typelevel.sbt.gha.WorkflowJob.withOses",
-  "org.typelevel.sbt.gha.WorkflowJob.withScalas",
-  "org.typelevel.sbt.gha.WorkflowJob.withJavas",
-  "org.typelevel.sbt.gha.WorkflowJob.withNeeds",
-  "org.typelevel.sbt.gha.WorkflowJob.withMatrixFailFast",
-  "org.typelevel.sbt.gha.WorkflowJob.withMatrixAdds",
-  "org.typelevel.sbt.gha.WorkflowJob.withMatrixIncs",
-  "org.typelevel.sbt.gha.WorkflowJob.withMatrixExcs",
-  "org.typelevel.sbt.gha.WorkflowJob.withRunsOnExtraLabels",
-  "org.typelevel.sbt.gha.WorkflowJob.withContainer",
-  "org.typelevel.sbt.gha.WorkflowJob.withEnvironment",
-  "org.typelevel.sbt.gha.WorkflowJob.withConcurrency",
-  "org.typelevel.sbt.gha.WorkflowJob.withTimeoutMinutes"
+  "org.typelevel.sbt.gha.WorkflowJob.*",
+  "org.typelevel.sbt.gha.WorkflowStep.**",
+  "org.typelevel.sbt.gha.WorkflowStep#Sbt.*",
+  "org.typelevel.sbt.gha.WorkflowStep#Run.*",
+  "org.typelevel.sbt.gha.WorkflowStep#Use.*"
 ).map(ProblemFilters.exclude[ReversedMissingMethodProblem](_))
diff --git a/github-actions/src/main/scala/org/typelevel/sbt/gha/WorkflowJob.scala b/github-actions/src/main/scala/org/typelevel/sbt/gha/WorkflowJob.scala
@@ -58,6 +58,11 @@ sealed abstract class WorkflowJob {
   def withEnvironment(environment: Option[JobEnvironment]): WorkflowJob
   def withConcurrency(concurrency: Option[Concurrency]): WorkflowJob
   def withTimeoutMinutes(timeoutMinutes: Option[Int]): WorkflowJob
+
+  def updatedEnv(name: String, value: String): WorkflowJob
+  def concatEnv(envs: TraversableOnce[(String, String)]): WorkflowJob
+  def appendedStep(step: WorkflowStep): WorkflowJob
+  def concatSteps(suffixSteps: TraversableOnce[WorkflowStep]): WorkflowJob
 }
 
 object WorkflowJob {
@@ -149,6 +154,11 @@ object WorkflowJob {
     override def withEnvironment(environment: Option[JobEnvironment]): WorkflowJob = copy(environment = environment)
     override def withConcurrency(concurrency: Option[Concurrency]): WorkflowJob = copy(concurrency = concurrency)
     override def withTimeoutMinutes(timeoutMinutes: Option[Int]): WorkflowJob = copy(timeoutMinutes = timeoutMinutes)
+
+    def updatedEnv(name: String, value: String): WorkflowJob = copy(env = env.updated(name, value))
+    def concatEnv(envs: TraversableOnce[(String, String)]): WorkflowJob = copy(env = this.env ++ envs)
+    def appendedStep(step: WorkflowStep): WorkflowJob = copy(steps = this.steps :+ step)
+    def concatSteps(suffixSteps: TraversableOnce[WorkflowStep]): WorkflowJob = copy(steps = this.steps ++ suffixSteps)
     // scalafmt: { maxColumn = 96 }
 
     override def productPrefix = "WorkflowJob"

diff --git a/github-actions/src/main/scala/org/typelevel/sbt/gha/WorkflowStep.scala b/github-actions/src/main/scala/org/typelevel/sbt/gha/WorkflowStep.scala
@@ -28,6 +28,9 @@ sealed abstract class WorkflowStep extends Product with Serializable {
   def withCond(cond: Option[String]): WorkflowStep
   def withEnv(env: Map[String, String]): WorkflowStep
   def withTimeoutMinutes(minutes: Option[Int]): WorkflowStep
+
+  def updatedEnv(name: String, value: String): WorkflowStep
+  def concatEnv(env: TraversableOnce[(String, String)]): WorkflowStep
 }
 
 object WorkflowStep {
@@ -118,6 +121,15 @@ object WorkflowStep {
     def commands: List[String]
     def params: Map[String, String]
     def workingDirectory: Option[String]
+
+    def withCommands(commands: List[String]): Run
+    def withParams(params: Map[String, String]): Run
+    def withWorkingDirectory(workingDirectory: Option[String]): Run
+
+    def updatedEnv(name: String, value: String): Run
+    def concatEnv(env: TraversableOnce[(String, String)]): Run
+    def updatedParams(name: String, value: String): Run
+    def concatParams(params: TraversableOnce[(String, String)]): Run
   }
 
   object Run {
@@ -143,18 +155,38 @@ object WorkflowStep {
         workingDirectory: Option[String])
         extends Run {
       override def productPrefix = "Run"
+      // scalafmt: { maxColumn = 200 }
       def withId(id: Option[String]) = copy(id = id)
       def withName(name: Option[String]) = copy(name = name)
       def withCond(cond: Option[String]) = copy(cond = cond)
       def withEnv(env: Map[String, String]) = copy(env = env)
       def withTimeoutMinutes(minutes: Option[Int]) = copy(timeoutMinutes = minutes)
+
+      def withCommands(commands: List[String]) = copy(commands = commands)
+      def withParams(params: Map[String, String]) = copy(params = params)
+      def withWorkingDirectory(workingDirectory: Option[String]) = copy(workingDirectory = workingDirectory)
+
+      def updatedEnv(name: String, value: String) = copy(env = this.env.updated(name, value))
+      def concatEnv(env: TraversableOnce[(String, String)]) = copy(env = this.env ++ env)
+      def updatedParams(name: String, value: String) = copy(params = this.params.updated(name, value))
+      def concatParams(params: TraversableOnce[(String, String)]) = copy(params = this.params ++ params)
+      // scalafmt: { maxColumn = 96 }
     }
   }
 
   sealed abstract class Sbt extends WorkflowStep {
     def commands: List[String]
     def params: Map[String, String]
     def preamble: Boolean
+
+    def withCommands(commands: List[String]): Sbt
+    def withParams(params: Map[String, String]): Sbt
+    def withPreamble(preamble: Boolean): Sbt
+
+    def updatedEnv(name: String, value: String): Sbt
+    def concatEnv(env: TraversableOnce[(String, String)]): Sbt
+    def updatedParams(name: String, value: String): Sbt
+    def concatParams(params: TraversableOnce[(String, String)]): Sbt
   }
 
   object Sbt {
@@ -180,17 +212,36 @@ object WorkflowStep {
         preamble: Boolean)
         extends Sbt {
       override def productPrefix = "Sbt"
+      // scalafmt: { maxColumn = 200 }
       def withId(id: Option[String]) = copy(id = id)
       def withName(name: Option[String]) = copy(name = name)
       def withCond(cond: Option[String]) = copy(cond = cond)
       def withEnv(env: Map[String, String]) = copy(env = env)
       def withTimeoutMinutes(minutes: Option[Int]) = copy(timeoutMinutes = minutes)
+
+      def withCommands(commands: List[String]) = copy(commands = commands)
+      def withParams(params: Map[String, String]) = copy(params = params)
+      def withPreamble(preamble: Boolean) = copy(preamble = preamble)
+
+      def updatedEnv(name: String, value: String) = copy(env = this.env.updated(name, value))
+      def concatEnv(env: TraversableOnce[(String, String)]) = copy(env = this.env ++ env)
+      def updatedParams(name: String, value: String) = copy(params = params.updated(name, value))
+      def concatParams(params: TraversableOnce[(String, String)]) = copy(params = this.params ++ params)
+      // scalafmt: { maxColumn = 96 }
     }
   }
 
   sealed abstract class Use extends WorkflowStep {
     def ref: UseRef
     def params: Map[String, String]
+
+    def withRef(ref: UseRef): Use
+    def withParams(params: Map[String, String]): Use
+
+    def updatedEnv(name: String, value: String): Use
+    def concatEnv(env: TraversableOnce[(String, String)]): Use
+    def updatedParams(name: String, value: String): Use
+    def concatParams(params: TraversableOnce[(String, String)]): Use
   }
 
   object Use {
@@ -215,11 +266,21 @@ object WorkflowStep {
         timeoutMinutes: Option[Int])
         extends Use {
       override def productPrefix = "Use"
+      // scalafmt: { maxColumn = 200 }
       def withId(id: Option[String]) = copy(id = id)
       def withName(name: Option[String]) = copy(name = name)
       def withCond(cond: Option[String]) = copy(cond = cond)
       def withEnv(env: Map[String, String]) = copy(env = env)
       def withTimeoutMinutes(minutes: Option[Int]) = copy(timeoutMinutes = minutes)
+
+      def withRef(ref: UseRef) = copy(ref = ref)
+      def withParams(params: Map[String, String]) = copy(params = params)
+
+      def updatedEnv(name: String, value: String) = copy(env = this.env.updated(name, value))
+      def concatEnv(env: TraversableOnce[(String, String)]) = copy(env = this.env ++ env)
+      def updatedParams(name: String, value: String) = copy(params = params.updated(name, value))
+      def concatParams(params: TraversableOnce[(String, String)]) = copy(params = this.params ++ params)
+      // scalafmt: { maxColumn = 96 }
     }
   }
 }