feat(abg)!: allow running generateActionBindings from any directory (#…

…1184) Part of #1071. Thanks to this, it's possible to e. g. click the green "run" arrow in IntelliJ to run the script.
typesafegithub · Dec 11, 2023 · 12db971 · 12db971
1 parent 8b8732c
commit 12db971
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/action-binding-generator/api/action-binding-generator.api b/action-binding-generator/api/action-binding-generator.api
@@ -65,7 +65,7 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/Fro
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/GenerateActionBindingsCliHelperKt {
-	public static final fun generateActionBindings ([Ljava/lang/String;)V
+	public static final fun generateActionBindings ([Ljava/lang/String;Ljava/nio/file/Path;)V
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/GenerationKt {

diff --git a/action-binding-generator/build.gradle.kts b/action-binding-generator/build.gradle.kts
@@ -14,6 +14,7 @@ version = rootProject.version
 dependencies {
     implementation("com.squareup:kotlinpoet:1.15.3")
     implementation("com.charleskorn.kaml:kaml:0.56.0")
+    implementation(projects.sharedInternal)
 
     testImplementation(projects.githubWorkflowsKt)
 }

diff --git a/...github/typesafegithub/workflows/actionbindinggenerator/GenerateActionBindingsCliHelper.kt b/...github/typesafegithub/workflows/actionbindinggenerator/GenerateActionBindingsCliHelper.kt
@@ -1,39 +1,47 @@
 package io.github.typesafegithub.workflows.actionbindinggenerator
 
-import java.io.File
-import kotlin.io.path.Path
+import io.github.typesafegithub.workflows.shared.internal.findGitRoot
+import java.nio.file.Path
+import kotlin.io.path.div
 
 /**
  * Implements the suggested logic of a script that is called to regenerate action bindings.
  *
  * @param args Whatever was passed to the script. The exact inputs are opaque and for now are an implementation detail
  * of the library, i.e. whatever YAML was generated by the library, it will produce correct input to the script and thus
  * this function.
+ * @param sourceFile Path to the script where this function is called from. Typically a result of an expression like
+ * [__FILE__.toPath()].
  */
-public fun generateActionBindings(args: Array<String>) {
+public fun generateActionBindings(
+    args: Array<String>,
+    sourceFile: Path,
+) {
     val workflowYamlFileName: String? =
         when {
             args.isEmpty() -> null
             args.size == 1 -> args[0]
             else -> error("At most one argument is supported!")
         }
 
+    val githubWorkflowsDir = sourceFile.findGitRoot() / ".github" / "workflows"
+
     val allUsedActions =
         extractUsedActionsFromWorkflow(
-            manifest = File(".github/workflows/_used-actions.yaml").readText(),
+            manifest = (githubWorkflowsDir / "_used-actions.yaml").toFile().readText(),
         )
 
     val actionsToGenerateBindingsFor =
         workflowYamlFileName?.let {
             val actionsUsedInRequestedWorkflow =
                 extractUsedActionsFromWorkflow(
-                    manifest = File(".github/workflows/$workflowYamlFileName").readText(),
+                    manifest = (githubWorkflowsDir / workflowYamlFileName).toFile().readText(),
                 )
             allUsedActions.intersect(actionsUsedInRequestedWorkflow.toSet())
         } ?: allUsedActions
 
     actionsToGenerateBindingsFor.forEach { action ->
-        Path(".github").resolve("workflows").resolve("generated").resolve(action.owner).resolve("${action.name}.kt").let {
+        (githubWorkflowsDir / "generated" / action.owner / "${action.name}.kt").let {
             it.parent.toFile().mkdirs()
             val binding =
                 action.generateBinding(