Skip to content

Commit 3d8cba8

Browse files
ingemaradahlingemaradahl
committed
Add support calling reusable workflow
1 parent 793c0c0 commit 3d8cba8

File tree

4 files changed

+294
-13
lines changed

4 files changed

+294
-13
lines changed

‎src/main/scala/sbtghactions/GenerativePlugin.scala‎

Lines changed: 58 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ object GenerativePlugin extends AutoPlugin {
7373
type Concurrency = sbtghactions.Concurrency
7474
val Concurrency = sbtghactions.Concurrency
7575

76+
type Secrets = sbtghactions.Secrets
77+
val Secrets = sbtghactions.Secrets
78+
7679
type Graalvm = sbtghactions.Graalvm
7780
val Graalvm = sbtghactions.Graalvm
7881
}
@@ -187,6 +190,12 @@ object GenerativePlugin extends AutoPlugin {
187190
s"concurrency: ${wrap(concurrency.group)}"
188191
}
189192

193+
def compileSecrets(secrets: Secrets): String =
194+
secrets match {
195+
case Secrets.Inherit => "secrets: inherit"
196+
case Secrets.Explicit(secretMap) => compileEnv(secretMap, "secrets")
197+
}
198+
190199
def compileEnvironment(environment: JobEnvironment): String =
191200
environment.url match {
192201
case Some(url) =>
@@ -355,6 +364,8 @@ ${indent(rendered.mkString("\n"), 1)}"""
355364

356365

357366
def compileJob(job: WorkflowJob, sbt: String): String = {
367+
val renderedName = s"""name: ${wrap(job.name)}"""
368+
358369
val renderedNeeds = if (job.needs.isEmpty)
359370
""
360371
else
@@ -485,24 +496,60 @@ ${indent(rendered.mkString("\n"), 1)}"""
485496

486497
val declareShell = job.oses.exists(_.contains("windows"))
487498

488-
val runsOn = if (job.runsOnExtraLabels.isEmpty)
489-
s"$${{ matrix.os }}"
490-
else
491-
job.runsOnExtraLabels.mkString(s"""[ "$${{ matrix.os }}", """, ", ", " ]" )
499+
val runsOn = job match {
500+
case jobWithSteps: WorkflowJob.Steps if jobWithSteps.runsOnExtraLabels.isEmpty =>
501+
"\nruns-on: ${{ matrix.os }}"
502+
case jobWithSteps: WorkflowJob.Steps =>
503+
jobWithSteps.runsOnExtraLabels.mkString(s"""\nruns-on: [ "$${{ matrix.os }}", """, ", ", " ]")
504+
case _ =>
505+
""
506+
}
492507

493508
val renderedFailFast = job.matrixFailFast.fold("")("\n fail-fast: " + _)
494509

495-
val body = s"""name: ${wrap(job.name)}${renderedNeeds}${renderedCond}
496-
strategy:${renderedFailFast}
510+
val renderedStrategy = s"""\nstrategy:${renderedFailFast}
497511
matrix:
498512
os:${compileList(job.oses, 3)}
499513
scala:${compileList(job.scalas, 3)}
500-
java:${compileList(job.javas.map(_.render), 3)}${renderedMatrices}
501-
runs-on: ${runsOn}${renderedEnvironment}${renderedContainer}${renderedTimeout}${renderedPerm}${renderedEnv}${renderedConcurrency}
502-
steps:
503-
${indent(job.steps.map(compileStep(_, sbt, job.sbtStepPreamble, declareShell = declareShell)).mkString("\n\n"), 1)}"""
514+
java:${compileList(job.javas.map(_.render), 3)}"""
515+
516+
val renderedSteps = job match {
517+
case jobWithSteps: WorkflowJob.Steps =>
518+
"\nsteps:\n" +
519+
indent(jobWithSteps.steps.map(compileStep(_, sbt, jobWithSteps.sbtStepPreamble, declareShell = declareShell)).mkString("\n\n"), 1)
520+
case _ =>
521+
""
522+
}
523+
524+
val renderedUses = job match {
525+
case uses: WorkflowJob.Use =>
526+
val renderedSecrets =
527+
uses.secrets.map(compileSecrets).map("\n" + _).getOrElse("")
528+
529+
s"\nuses: ${uses.ref}${renderParams(uses.params)}${renderedSecrets}"
530+
case _ =>
531+
""
532+
}
533+
504534

505-
s"${job.id}:\n${indent(body, 1)}"
535+
val content = List(
536+
renderedName,
537+
renderedNeeds,
538+
renderedCond,
539+
renderedStrategy,
540+
renderedMatrices,
541+
runsOn,
542+
renderedEnvironment,
543+
renderedContainer,
544+
renderedTimeout,
545+
renderedPerm,
546+
renderedEnv,
547+
renderedConcurrency,
548+
renderedSteps,
549+
renderedUses,
550+
).reduce(_ ++ _)
551+
552+
s"${job.id}:\n${indent(content, 1)}"
506553
}
507554

508555
def compileWorkflow(

‎src/main/scala/sbtghactions/Secrets.scala‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Copyright 2020-2021 Daniel Spiewak
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package sbtghactions
18+
19+
sealed trait Secrets extends Product with Serializable
20+
21+
object Secrets {
22+
case object Inherit extends Secrets
23+
case class Explicit(secrets: Map[String, String]) extends Secrets
24+
}

‎src/main/scala/sbtghactions/WorkflowJob.scala‎

Lines changed: 94 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,28 @@ package sbtghactions
1818

1919
import scala.concurrent.duration.FiniteDuration
2020

21-
final case class WorkflowJob(
21+
sealed abstract class WorkflowJob {
22+
def id: String
23+
def name: String
24+
def cond: Option[String]
25+
def permissions: Option[Permissions]
26+
def env: Map[String, String]
27+
def oses: List[String]
28+
def scalas: List[String]
29+
def javas: List[JavaSpec]
30+
def needs: List[String]
31+
def matrixFailFast: Option[Boolean]
32+
def matrixAdds: Map[String, List[String]]
33+
def matrixIncs: List[MatrixInclude]
34+
def matrixExcs: List[MatrixExclude]
35+
def container: Option[JobContainer]
36+
def environment: Option[JobEnvironment]
37+
def concurrency: Option[Concurrency]
38+
def timeout: Option[FiniteDuration]
39+
}
40+
41+
object WorkflowJob {
42+
def apply(
2243
id: String,
2344
name: String,
2445
steps: List[WorkflowStep],
@@ -38,4 +59,75 @@ final case class WorkflowJob(
3859
container: Option[JobContainer] = None,
3960
environment: Option[JobEnvironment] = None,
4061
concurrency: Option[Concurrency] = None,
41-
timeout: Option[FiniteDuration] = None)
62+
timeout: Option[FiniteDuration] = None
63+
): WorkflowJob =
64+
Steps(
65+
id,
66+
name,
67+
steps,
68+
sbtStepPreamble,
69+
cond,
70+
permissions,
71+
env,
72+
oses,
73+
scalas,
74+
javas,
75+
needs,
76+
matrixFailFast,
77+
matrixAdds,
78+
matrixIncs,
79+
matrixExcs,
80+
runsOnExtraLabels,
81+
container,
82+
environment,
83+
concurrency,
84+
timeout
85+
)
86+
87+
final case class Steps(
88+
id: String,
89+
name: String,
90+
steps: List[WorkflowStep],
91+
sbtStepPreamble: List[String] = List(),
92+
cond: Option[String] = None,
93+
permissions: Option[Permissions] = None,
94+
env: Map[String, String] = Map(),
95+
oses: List[String] = List("ubuntu-latest"),
96+
scalas: List[String] = List("2.13.10"),
97+
javas: List[JavaSpec] = List(JavaSpec.zulu("8")),
98+
needs: List[String] = List(),
99+
matrixFailFast: Option[Boolean] = None,
100+
matrixAdds: Map[String, List[String]] = Map(),
101+
matrixIncs: List[MatrixInclude] = List(),
102+
matrixExcs: List[MatrixExclude] = List(),
103+
runsOnExtraLabels: List[String] = List(),
104+
container: Option[JobContainer] = None,
105+
environment: Option[JobEnvironment] = None,
106+
concurrency: Option[Concurrency] = None,
107+
timeout: Option[FiniteDuration] = None
108+
) extends WorkflowJob
109+
110+
final case class Use(
111+
id: String,
112+
name: String,
113+
ref: String,
114+
params: Map[String, String] = Map.empty,
115+
secrets: Option[Secrets] = None,
116+
cond: Option[String] = None,
117+
permissions: Option[Permissions] = None,
118+
oses: List[String] = List("ubuntu-latest"),
119+
scalas: List[String] = List("2.13.10"),
120+
javas: List[JavaSpec] = List(JavaSpec.zulu("8")),
121+
needs: List[String] = List(),
122+
matrixFailFast: Option[Boolean] = None,
123+
matrixAdds: Map[String, List[String]] = Map(),
124+
matrixIncs: List[MatrixInclude] = List(),
125+
matrixExcs: List[MatrixExclude] = List(),
126+
concurrency: Option[Concurrency] = None,
127+
) extends WorkflowJob {
128+
override def env: Map[String, String] = Map.empty
129+
override def environment: Option[JobEnvironment] = None
130+
override def timeout: Option[FiniteDuration] = None
131+
override def container: Option[JobContainer] = None
132+
}
133+
}

‎src/test/scala/sbtghactions/GenerativePluginSpec.scala‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,6 +1092,124 @@ class GenerativePluginSpec extends Specification {
10921092
- name: Checkout current branch (fast)
10931093
uses: actions/checkout@v5"""
10941094
}
1095+
1096+
"compile a job which delegates to another via 'using'" in {
1097+
val results = compileJob(
1098+
WorkflowJob.Use(
1099+
"publish",
1100+
"Publish Release",
1101+
"./.github/workflows/dependant.yml"),
1102+
"csbt")
1103+
1104+
results mustEqual s"""publish:
1105+
name: Publish Release
1106+
strategy:
1107+
matrix:
1108+
os: [ubuntu-latest]
1109+
scala: [2.13.10]
1110+
java: [zulu@8]
1111+
uses: ./.github/workflows/dependant.yml"""
1112+
}
1113+
1114+
"compile a job which delegates to another via 'using', with parameters" in {
1115+
val results = compileJob(
1116+
WorkflowJob.Use(
1117+
"publish",
1118+
"Publish Release",
1119+
"sbt/sbt-github-actions/.github/workflows/dependant.yml@main",
1120+
Map("abc" -> "def")
1121+
),
1122+
"csbt")
1123+
1124+
results mustEqual s"""publish:
1125+
name: Publish Release
1126+
strategy:
1127+
matrix:
1128+
os: [ubuntu-latest]
1129+
scala: [2.13.10]
1130+
java: [zulu@8]
1131+
uses: sbt/sbt-github-actions/.github/workflows/dependant.yml@main
1132+
with:
1133+
abc: def"""
1134+
}
1135+
1136+
"compile a job which delegates to another via 'using', with inherited secrets" in {
1137+
val results = compileJob(
1138+
WorkflowJob.Use(
1139+
"publish",
1140+
"Publish Release",
1141+
"./.github/workflows/dependant.yml",
1142+
secrets = Some(Secrets.Inherit)
1143+
),
1144+
"csbt")
1145+
1146+
results mustEqual s"""publish:
1147+
name: Publish Release
1148+
strategy:
1149+
matrix:
1150+
os: [ubuntu-latest]
1151+
scala: [2.13.10]
1152+
java: [zulu@8]
1153+
uses: ./.github/workflows/dependant.yml
1154+
secrets: inherit"""
1155+
}
1156+
1157+
"compile a job which delegates to another via 'using', with explicit secrets" in {
1158+
val results = compileJob(
1159+
WorkflowJob.Use(
1160+
"publish",
1161+
"Publish Release",
1162+
"./.github/workflows/dependant.yml",
1163+
secrets = Some(Secrets.Explicit(Map("abc" -> "def")))
1164+
),
1165+
"csbt")
1166+
1167+
results mustEqual s"""publish:
1168+
name: Publish Release
1169+
strategy:
1170+
matrix:
1171+
os: [ubuntu-latest]
1172+
scala: [2.13.10]
1173+
java: [zulu@8]
1174+
uses: ./.github/workflows/dependant.yml
1175+
secrets:
1176+
abc: def"""
1177+
}
1178+
1179+
"compile a job which delegates to another via 'using', with supported keywords" in {
1180+
val results = compileJob(
1181+
WorkflowJob.Use(
1182+
"publish",
1183+
"Publish Release",
1184+
"./.github/workflows/dependant.yml",
1185+
params = Map("abc" -> "def"),
1186+
secrets = Some(Secrets.Explicit(Map("abc" -> "def"))),
1187+
cond = Some("true"),
1188+
permissions = Some(Permissions.ReadAll),
1189+
needs = List("build"),
1190+
concurrency = Some(Concurrency("publish-group", Some(true))),
1191+
),
1192+
"csbt")
1193+
1194+
results mustEqual s"""publish:
1195+
name: Publish Release
1196+
needs: [build]
1197+
if: true
1198+
strategy:
1199+
matrix:
1200+
os: [ubuntu-latest]
1201+
scala: [2.13.10]
1202+
java: [zulu@8]
1203+
permissions: read-all
1204+
concurrency:
1205+
group: publish-group
1206+
cancel-in-progress: true
1207+
uses: ./.github/workflows/dependant.yml
1208+
with:
1209+
abc: def
1210+
secrets:
1211+
abc: def"""
1212+
}
10951213
}
10961214

10971215
"predicate compilation" >> {

0 commit comments

Comments
 (0)