Add GitHub workflow transformation module with names field support

Copilot · pelikhan · Copilot · commit 73bae55e7c6b · 2025-10-03T14:44:43.000Z
Co-authored-by: pelikhan &lt;4175913+pelikhan@users.noreply.github.com&gt;
diff --git a/packages/core/src/githubworkflow.test.ts b/packages/core/src/githubworkflow.test.ts
@@ -0,0 +1,193 @@
+import { describe, test } from "node:test"
+import assert from "node:assert/strict"
+import { processGitHubWorkflow } from "./githubworkflow"
+import { YAMLParse } from "./yaml"
+
+describe("GitHubWorkflow", () => {
+    describe("processGitHubWorkflow", () => {
+        test("should handle labeled event with names field", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [labeled]
+    names: [bug, enhancement]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "test"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Names field should be removed
+            assert.strictEqual(workflow.on.issues.names, undefined)
+            
+            // Job should have if condition
+            assert.ok(workflow.jobs.test.if)
+            assert.ok(workflow.jobs.test.if.includes('github.event.label.name'))
+            assert.ok(workflow.jobs.test.if.includes('bug'))
+            assert.ok(workflow.jobs.test.if.includes('enhancement'))
+        })
+        
+        test("should handle unlabeled event with names field", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [unlabeled]
+    names: [wontfix]
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "cleanup"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Names field should be removed
+            assert.strictEqual(workflow.on.issues.names, undefined)
+            
+            // Job should have if condition
+            assert.ok(workflow.jobs.cleanup.if)
+            assert.ok(workflow.jobs.cleanup.if.includes('wontfix'))
+        })
+        
+        test("should handle both labeled and unlabeled in same trigger", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [labeled, unlabeled]
+    names: [bug, feature]
+jobs:
+  process:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "process"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Names field should be removed
+            assert.strictEqual(workflow.on.issues.names, undefined)
+            
+            // Job should have if condition
+            assert.ok(workflow.jobs.process.if)
+            assert.ok(workflow.jobs.process.if.includes('bug'))
+            assert.ok(workflow.jobs.process.if.includes('feature'))
+        })
+        
+        test("should preserve existing if conditions", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [labeled]
+    names: [critical]
+jobs:
+  alert:
+    runs-on: ubuntu-latest
+    if: github.repository == 'owner/repo'
+    steps:
+      - run: echo "alert"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Job should have combined if condition
+            assert.ok(workflow.jobs.alert.if)
+            assert.ok(workflow.jobs.alert.if.includes('github.repository'))
+            assert.ok(workflow.jobs.alert.if.includes('critical'))
+            assert.ok(workflow.jobs.alert.if.includes('&&'))
+        })
+        
+        test("should not modify workflow without names field", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [labeled]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "test"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Job should not have if condition added
+            assert.strictEqual(workflow.jobs.test.if, undefined)
+        })
+        
+        test("should not modify workflow without labeled/unlabeled types", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [opened]
+    names: [something]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "test"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Names field should still be there (not removed)
+            // because it's not on a labeled/unlabeled trigger
+            assert.deepStrictEqual(workflow.on.issues.names, ['something'])
+            
+            // Job should not have if condition added
+            assert.strictEqual(workflow.jobs.test.if, undefined)
+        })
+        
+        test("should handle multiple jobs", () => {
+            const input = `name: Test Workflow
+on:
+  issues:
+    types: [labeled]
+    names: [urgent]
+jobs:
+  job1:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "job1"
+  job2:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "job2"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Both jobs should have if condition
+            assert.ok(workflow.jobs.job1.if)
+            assert.ok(workflow.jobs.job1.if.includes('urgent'))
+            assert.ok(workflow.jobs.job2.if)
+            assert.ok(workflow.jobs.job2.if.includes('urgent'))
+        })
+        
+        test("should handle pull_request events", () => {
+            const input = `name: Test Workflow
+on:
+  pull_request:
+    types: [labeled]
+    names: [approved]
+jobs:
+  merge:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "merge"
+`
+            const result = processGitHubWorkflow(input)
+            const workflow = YAMLParse(result)
+            
+            // Names field should be removed
+            assert.strictEqual(workflow.on.pull_request.names, undefined)
+            
+            // Job should have if condition
+            assert.ok(workflow.jobs.merge.if)
+            assert.ok(workflow.jobs.merge.if.includes('approved'))
+        })
+    })
+})
diff --git a/packages/core/src/githubworkflow.ts b/packages/core/src/githubworkflow.ts
@@ -0,0 +1,105 @@
+/**
+ * This module provides utilities for processing GitHub Actions workflow files,
+ * specifically handling the transformation of labeled/unlabeled triggers with
+ * the "names" field into conditional expressions.
+ */
+
+import { YAMLParse, YAMLStringify } from "./yaml"
+
+interface GitHubWorkflowTrigger {
+    types?: string[]
+    names?: string[]
+    [key: string]: any
+}
+
+interface GitHubWorkflowOn {
+    issues?: GitHubWorkflowTrigger
+    pull_request?: GitHubWorkflowTrigger
+    pull_request_target?: GitHubWorkflowTrigger
+    [key: string]: any
+}
+
+interface GitHubWorkflowJob {
+    if?: string
+    [key: string]: any
+}
+
+interface GitHubWorkflow {
+    on?: GitHubWorkflowOn
+    jobs?: Record<string, GitHubWorkflowJob>
+    [key: string]: any
+}
+
+/**
+ * Processes a GitHub Actions workflow to handle the "names" field under
+ * labeled/unlabeled triggers. The "names" field is removed from the workflow
+ * and converted into conditional if expressions on the jobs.
+ *
+ * @param workflowYaml - The workflow YAML content as a string
+ * @returns The processed workflow YAML as a string
+ */
+export function processGitHubWorkflow(workflowYaml: string): string {
+    const workflow: GitHubWorkflow = YAMLParse(workflowYaml)
+    
+    if (!workflow.on || !workflow.jobs) {
+        return workflowYaml
+    }
+
+    // Track which event triggers have names that need to be converted
+    const labelConditions: string[] = []
+    
+    // Process each event type in the "on" section
+    for (const [eventKey, eventConfig] of Object.entries(workflow.on)) {
+        if (typeof eventConfig === 'object' && eventConfig !== null) {
+            const trigger = eventConfig as GitHubWorkflowTrigger
+            
+            // Check if this trigger has types array containing labeled or unlabeled
+            if (trigger.types && trigger.names) {
+                const hasLabeledOrUnlabeled = trigger.types.some(
+                    (type: string) => type === 'labeled' || type === 'unlabeled'
+                )
+                
+                if (hasLabeledOrUnlabeled) {
+                    // Create the conditional expression
+                    const namesArray = JSON.stringify(trigger.names)
+                    const labelField = 'github.event.label.name'
+                    const condition = `contains(fromJSON('${namesArray}'), ${labelField})`
+                    labelConditions.push(condition)
+                    
+                    // Remove the names field from the trigger
+                    delete trigger.names
+                }
+            }
+        }
+    }
+    
+    // If we found label conditions, add them to jobs
+    if (labelConditions.length > 0) {
+        const combinedCondition = labelConditions.join(' || ')
+        
+        // Add the condition to all jobs
+        for (const [jobKey, job] of Object.entries(workflow.jobs)) {
+            if (job.if) {
+                // Combine with existing condition
+                job.if = `(${job.if}) && (${combinedCondition})`
+            } else {
+                // Add new condition
+                job.if = combinedCondition
+            }
+        }
+    }
+    
+    return YAMLStringify(workflow)
+}
+
+/**
+ * Processes a GitHub Actions workflow file to handle the "names" field.
+ * This is a convenience wrapper around processGitHubWorkflow that handles
+ * file input/output.
+ *
+ * @param workflowContent - The workflow YAML content
+ * @returns The processed workflow YAML content
+ */
+export function transformGitHubWorkflowLabels(workflowContent: string): string {
+    return processGitHubWorkflow(workflowContent)
+}
