fix(library)!: allow running Kotlin-based step if multiple workflows in single file (#1870)

Resolves
#1811.

Includes target workflow name in an environment variable used to select
which Kotlin-based step to run. Before this fix, if there were multiple
workflows per a .main.kts file, there was a runtime error. Thanks to
this fix, things work fine as long as each workflow has a different
`targetFileName`.

Author: krzema12

.github/workflows/end-to-end-tests-2nd-workflow.yaml

@@ -0,0 +1,59 @@
+# This file was generated using Kotlin DSL (.github/workflows/end-to-end-tests.main.kts).
+# If you want to modify the workflow, please change the Kotlin file and regenerate this YAML file.
+# Generated with https://github.com/typesafegithub/github-workflows-kt
+
+name: 'End-to-end tests (2nd workflow)'
+on:
+  push:
+    branches:
+    - 'main'
+  pull_request: {}
+jobs:
+  check_yaml_consistency:
+    name: 'Check YAML consistency'
+    runs-on: 'ubuntu-latest'
+    steps:
+    - id: 'step-0'
+      name: 'Check out'
+      uses: 'actions/checkout@v4'
+    - id: 'step-1'
+      name: 'Set up JDK'
+      uses: 'actions/setup-java@v4'
+      with:
+        java-version: '11'
+        distribution: 'zulu'
+    - id: 'step-2'
+      uses: 'gradle/actions/setup-gradle@v4'
+    - id: 'step-3'
+      name: 'Publish to Maven local'
+      run: './gradlew publishToMavenLocal'
+    - id: 'step-4'
+      name: 'Execute script'
+      run: 'rm ''.github/workflows/end-to-end-tests-2nd-workflow.yaml'' && ''.github/workflows/end-to-end-tests.main.kts'''
+    - id: 'step-5'
+      name: 'Consistency check'
+      run: 'git diff --exit-code ''.github/workflows/end-to-end-tests-2nd-workflow.yaml'''
+  another_job:
+    runs-on: 'ubuntu-latest'
+    needs:
+    - 'check_yaml_consistency'
+    steps:
+    - id: 'step-0'
+      name: 'Check out'
+      uses: 'actions/checkout@v4'
+    - id: 'step-1'
+      name: 'Set up JDK'
+      uses: 'actions/setup-java@v4'
+      with:
+        java-version: '11'
+        distribution: 'zulu'
+    - id: 'step-2'
+      uses: 'gradle/actions/setup-gradle@v4'
+    - id: 'step-3'
+      name: 'Publish to Maven local'
+      run: './gradlew publishToMavenLocal'
+    - id: 'step-4'
+      name: 'Step with a Kotlin-based logic, in a different workflow'
+      env:
+        GHWKT_GITHUB_CONTEXT_JSON: '${{ toJSON(github) }}'
+      run: 'GHWKT_RUN_STEP=''end-to-end-tests-2nd-workflow.yaml:another_job:step-4'' ''.github/workflows/end-to-end-tests.main.kts'''

.github/workflows/end-to-end-tests.main.kts

@@ -273,3 +273,36 @@ workflow(
         )
     }
 }
+
+workflow(
+    name = "End-to-end tests (2nd workflow)",
+    on = listOf(
+        Push(branches = listOf("main")),
+        PullRequest(),
+    ),
+    consistencyCheckJobConfig = DEFAULT_CONSISTENCY_CHECK_JOB_CONFIG.copy(
+        additionalSteps = {
+            publishToMavenLocal()
+        },
+    ),
+    sourceFile = __FILE__,
+    targetFileName = "end-to-end-tests-2nd-workflow.yaml",
+) {
+    job(
+        id = "another_job",
+        runsOn = RunnerType.UbuntuLatest,
+    ) {
+        uses(
+            name = "Check out",
+            action = Checkout(),
+        )
+
+        publishToMavenLocal()
+
+        run(
+            name = "Step with a Kotlin-based logic, in a different workflow",
+        ) {
+            println("Hello from Kotlin!")
+        }
+    }
+}

.github/workflows/end-to-end-tests.yaml

@@ -131,12 +131,12 @@ jobs:
       name: 'Evaluating condition for ''Step with a Kotlin-based logic'''
       env:
         GHWKT_GITHUB_CONTEXT_JSON: '${{ toJSON(github) }}'
-      run: 'GHWKT_RUN_STEP=''test_job_1:step-18'' ''.github/workflows/end-to-end-tests.main.kts'''
+      run: 'GHWKT_RUN_STEP=''end-to-end-tests.yaml:test_job_1:step-18'' ''.github/workflows/end-to-end-tests.main.kts'''
     - id: 'step-19'
       name: 'Step with a Kotlin-based logic'
       env:
         GHWKT_GITHUB_CONTEXT_JSON: '${{ toJSON(github) }}'
-      run: 'GHWKT_RUN_STEP=''test_job_1:step-19'' ''.github/workflows/end-to-end-tests.main.kts'''
+      run: 'GHWKT_RUN_STEP=''end-to-end-tests.yaml:test_job_1:step-19'' ''.github/workflows/end-to-end-tests.main.kts'''
       if: '${{ steps.step-18.outputs.evaluation-result }}'
     - id: 'step-20'
       uses: 'actions/github-script@v7'

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/dsl/JobBuilder.kt

@@ -142,11 +142,17 @@ public class JobBuilder<OUTPUT : JobOutputs>(
             workflowBuilder.gitRootDir?.let {
                 sourceFile.toPath().relativeToAbsolute(it).invariantSeparatorsPathString
             }
+        val commandParts =
+            listOf(
+                this.workflowBuilder.workflow.targetFileName,
+                this.id,
+                id,
+            )
         val newStep =
             KotlinLogicStep(
                 id = id,
                 name = name,
-                command = "GHWKT_RUN_STEP='${this.id}:$id' '$sourceFilePath'",
+                command = "GHWKT_RUN_STEP='${commandParts.joinToString(":")}' '$sourceFilePath'",
                 logic = logic,
                 env = env + mapOf("GHWKT_GITHUB_CONTEXT_JSON" to "\${{ toJSON(github) }}"),
                 condition =

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/yaml/ToYaml.kt

@@ -37,7 +37,15 @@ internal fun Workflow.writeToFile(
     val runStepEnvVar = getenv("GHWKT_RUN_STEP")
 
     if (runStepEnvVar != null) {
-        val (jobId, stepId) = runStepEnvVar.split(":")
+        val (targetFileName, jobId, stepId) = runStepEnvVar.split(":")
+
+        if (this.targetFileName != targetFileName) {
+            // Handles a case where there are multiple workflows with Kotlin-based
+            // steps in a single .main.kts file. Thanks to this check, only the step
+            // from the desired workflow is run.
+            return
+        }
+
         val kotlinLogicStep =
             this.jobs
                 .first { it.id == jobId }