-
Notifications
You must be signed in to change notification settings - Fork 473
Expand file tree
/
Copy pathcompiler_orchestrator_workflow.go
More file actions
701 lines (628 loc) · 26.7 KB
/
Copy pathcompiler_orchestrator_workflow.go
File metadata and controls
701 lines (628 loc) · 26.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
package workflow
import (
"encoding/json"
"fmt"
"github.com/github/gh-aw/pkg/logger"
"github.com/github/gh-aw/pkg/parser"
"github.com/github/gh-aw/pkg/setutil"
)
var orchestratorWorkflowLog = logger.New("workflow:compiler_orchestrator_workflow")
// workflowBuildContext captures the shared state across parse setup, validation,
// and workflow population phases.
//
// setupWorkflowBuildContext must run before validateWorkflowBuildContext or
// populateWorkflowBuildContext. engineSetup, toolsResult, and workflowData stay
// nil until setup completes successfully.
type workflowBuildContext struct {
cleanPath string
content []byte
frontmatter *parser.FrontmatterResult
markdownDir string
engineSetup *engineSetupResult
toolsResult *toolsProcessingResult
workflowData *WorkflowData
}
// ParseWorkflowFile parses a workflow markdown file and returns a WorkflowData structure.
// This is the main orchestration function that coordinates all compilation phases.
func (c *Compiler) ParseWorkflowFile(markdownPath string) (*WorkflowData, error) {
orchestratorWorkflowLog.Printf("Starting workflow file parsing: %s", markdownPath)
parseResult, err := c.parseFrontmatterSection(markdownPath)
if err != nil {
return nil, err
}
if err := validateParseResultWorkflowType(parseResult); err != nil {
return nil, err
}
ctx := newWorkflowBuildContext(parseResult)
if err := c.setupWorkflowBuildContext(ctx); err != nil {
return nil, err
}
if err := c.validateWorkflowBuildContext(ctx); err != nil {
return nil, err
}
if err := c.populateWorkflowBuildContext(ctx); err != nil {
return nil, err
}
orchestratorWorkflowLog.Printf("Workflow file parsing completed successfully: %s", markdownPath)
return ctx.workflowData, nil
}
func validateParseResultWorkflowType(parseResult *frontmatterParseResult) error {
if parseResult.isSharedWorkflow {
return &SharedWorkflowError{Path: parseResult.cleanPath}
}
if parseResult.isRedirectOnly {
return &RedirectOnlyWorkflowError{Path: parseResult.cleanPath, Target: parseResult.redirectTarget}
}
return nil
}
// newWorkflowBuildContext initializes build context from frontmatter parse results.
func newWorkflowBuildContext(parseResult *frontmatterParseResult) *workflowBuildContext {
return &workflowBuildContext{
cleanPath: parseResult.cleanPath,
content: parseResult.content,
frontmatter: parseResult.frontmatterResult,
markdownDir: parseResult.markdownDir,
}
}
// setupWorkflowBuildContext initializes engine/tools processing and builds base workflow data.
func (c *Compiler) setupWorkflowBuildContext(ctx *workflowBuildContext) error {
engineSetup, err := c.setupEngineAndImports(ctx.frontmatter, ctx.cleanPath, ctx.content, ctx.markdownDir)
if err != nil {
return c.formatEngineSetupError(ctx, err)
}
toolsResult, err := c.processToolsAndMarkdown(
ctx.frontmatter,
ctx.cleanPath,
ctx.markdownDir,
engineSetup.agenticEngine,
engineSetup.engineSetting,
engineSetup.importsResult,
)
if err != nil {
return c.formatToolsProcessingError(ctx.cleanPath, err)
}
ctx.engineSetup = engineSetup
ctx.toolsResult = toolsResult
ctx.workflowData = c.buildInitialWorkflowData(ctx.frontmatter, toolsResult, engineSetup, engineSetup.importsResult)
ctx.workflowData.WorkflowID = GetWorkflowIDFromPath(ctx.cleanPath)
return nil
}
func (c *Compiler) formatEngineSetupError(ctx *workflowBuildContext, err error) error {
if isFormattedCompilerError(err) {
return err
}
engineLine := findFrontmatterFieldLine(ctx.frontmatter.FrontmatterLines, ctx.frontmatter.FrontmatterStart, "engine")
if engineLine > 0 {
contextLines := readSourceContextLines(ctx.content, engineLine)
return formatCompilerErrorWithContext(ctx.cleanPath, engineLine, 1, "error", err.Error(), err, contextLines)
}
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
func (c *Compiler) formatToolsProcessingError(cleanPath string, err error) error {
if isFormattedCompilerError(err) {
return err
}
return formatCompilerError(cleanPath, "error", err.Error(), err)
}
// validateWorkflowBuildContext runs model, engine, and tool validations for the workflow.
func (c *Compiler) validateWorkflowBuildContext(ctx *workflowBuildContext) error {
if err := c.validateWorkflowModelAliasMap(ctx); err != nil {
return err
}
if err := c.validateWorkflowEngineSettings(ctx.cleanPath, ctx.workflowData); err != nil {
return err
}
return c.validateWorkflowToolConfigurations(ctx)
}
func (c *Compiler) validateWorkflowModelAliasMap(ctx *workflowBuildContext) error {
var engineModel string
if ctx.workflowData.EngineConfig != nil {
engineModel = ctx.workflowData.EngineConfig.Model
}
return c.validateModelAliasMap(ctx.workflowData.ModelMappings, nil, engineModel, ctx.cleanPath)
}
func (c *Compiler) validateWorkflowEngineSettings(cleanPath string, workflowData *WorkflowData) error {
// Preserve legacy ParseWorkflowFile error precedence: return the first
// engine-setting validation failure in the same order the monolithic
// implementation executed these checks.
checks := []func(*WorkflowData) error{
c.validateRunInstallScripts,
c.validateEngineVersion,
c.validatePlaywrightMode,
c.validateLSPSupport,
c.validateEngineHarnessScript,
c.validateEngineDriver,
c.validateEngineMCPSessionTimeout,
c.validateEngineMCPToolTimeout,
}
for _, check := range checks {
if err := check(workflowData); err != nil {
return fmt.Errorf("%s: %w", cleanPath, err)
}
}
return nil
}
func (c *Compiler) validateWorkflowToolConfigurations(ctx *workflowBuildContext) error {
if ctx.workflowData.InlinedImports && ctx.engineSetup.importsResult.AgentFile != "" {
return formatCompilerError(ctx.cleanPath, "error",
fmt.Sprintf("inlined-imports cannot be used with agent file imports: '%s'. "+
"Agent files require runtime access and will not be resolved without sources. "+
"Remove 'inlined-imports: true' or do not import agent files.",
ctx.engineSetup.importsResult.AgentFile), nil)
}
if err := validateBashToolConfig(ctx.workflowData.ParsedTools, ctx.workflowData.Name); err != nil {
return fmt.Errorf("%s: %w", ctx.cleanPath, err)
}
if err := validateGitHubToolConfig(ctx.workflowData.ParsedTools, ctx.workflowData.Name); err != nil {
return fmt.Errorf("%s: %w", ctx.cleanPath, err)
}
if err := validateGitHubReadOnly(ctx.workflowData.ParsedTools, ctx.workflowData.Name); err != nil {
return fmt.Errorf("%s: %w", ctx.cleanPath, err)
}
if err := validateGitHubGuardPolicy(ctx.workflowData.ParsedTools, ctx.workflowData.Name); err != nil {
return fmt.Errorf("%s: %w", ctx.cleanPath, err)
}
emitGitHubLockdownGuardPolicyWarning(c, ctx.workflowData.ParsedTools, ctx.cleanPath)
var gatewayConfig *MCPGatewayRuntimeConfig
if ctx.workflowData.SandboxConfig != nil {
gatewayConfig = ctx.workflowData.SandboxConfig.MCP
}
if err := validateIntegrityReactions(ctx.workflowData.ParsedTools, ctx.workflowData.Name, ctx.workflowData, gatewayConfig); err != nil {
return fmt.Errorf("%s: %w", ctx.cleanPath, err)
}
return nil
}
// populateWorkflowBuildContext merges imported configuration and finalizes workflow data.
func (c *Compiler) populateWorkflowBuildContext(ctx *workflowBuildContext) error {
c.attachSharedActionResolver(ctx.workflowData)
if err := c.extractYAMLSections(ctx.frontmatter.Frontmatter, ctx.workflowData); err != nil {
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
if err := c.mergeImportedWorkflowConfiguration(ctx); err != nil {
return err
}
if err := c.processAndMergeSteps(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
if err := c.processAndMergePreSteps(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
if err := c.processAndMergePreAgentSteps(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
if err := c.processAndMergePostSteps(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return formatCompilerError(ctx.cleanPath, "error", err.Error(), err)
}
c.processAndMergeServices(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult)
ctx.workflowData.KnownActionCredentialEnvVars = DetectKnownCredentialLeakingActionsFromWorkflowData(ctx.workflowData)
if err := c.extractAdditionalConfigurations(ctx.frontmatter.Frontmatter, ctx.toolsResult.tools, ctx.markdownDir, ctx.workflowData, ctx.engineSetup.importsResult, ctx.toolsResult.rawMainMarkdown, ctx.toolsResult.safeOutputs); err != nil {
return err
}
if err := c.mergeImportedOnFields(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return err
}
return c.processOnSectionAndFilters(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.cleanPath)
}
func (c *Compiler) attachSharedActionResolver(workflowData *WorkflowData) {
actionCache, actionResolver := c.getSharedActionResolver()
workflowData.Ctx = c.ctx
workflowData.ActionCache = actionCache
workflowData.ActionResolver = actionResolver
workflowData.ActionPinWarnings = c.actionPinWarnings
workflowData.ActionPinMappings = c.getActionPinMappings()
}
func (c *Compiler) mergeImportedWorkflowConfiguration(ctx *workflowBuildContext) error {
c.mergeImportedObservability(ctx.workflowData, ctx.engineSetup.importsResult.MergedObservability)
if err := c.mergeWorkflowEnv(ctx.frontmatter.Frontmatter, ctx.workflowData, ctx.engineSetup.importsResult); err != nil {
return err
}
c.injectOTLPConfig(ctx.workflowData)
if len(ctx.engineSetup.importsResult.MergedFeatures) == 0 {
return nil
}
mergedFeatures, err := c.MergeFeatures(ctx.workflowData.Features, ctx.engineSetup.importsResult.MergedFeatures)
if err != nil {
return fmt.Errorf("failed to merge features from imports: %w", err)
}
ctx.workflowData.Features = mergedFeatures
return nil
}
// mergeImportedObservability merges imported OTLP config into raw frontmatter with main precedence.
func (c *Compiler) mergeImportedObservability(workflowData *WorkflowData, mergedObservability string) {
if mergedObservability == "" {
return
}
var importedObs map[string]any
if err := json.Unmarshal([]byte(mergedObservability), &importedObs); err != nil {
orchestratorWorkflowLog.Printf("Skipping imported observability merge: invalid JSON: %v", err)
return
}
mainObs := extractRawObservabilityMap(workflowData.RawFrontmatter)
mergedEndpoints, mainCount, importAdded := mergeRawOTLPEndpoints(mainObs, importedObs)
mergedAttrs := mergeOTLPStringMaps(
extractOTLPCustomAttributesFromObsMap(mainObs),
extractOTLPCustomAttributesFromObsMap(importedObs),
)
mergedResourceAttrs := mergeOTLPStringMaps(
extractOTLPResourceAttributesFromObsMap(mainObs),
extractOTLPResourceAttributesFromObsMap(importedObs),
)
githubApp := extractRawOTLPGitHubAppMap(mainObs)
if githubApp == nil {
githubApp = extractRawOTLPGitHubAppMap(importedObs)
}
applyMergedRawObservability(
workflowData.RawFrontmatter,
mergedEndpoints,
mergedAttrs,
mergedResourceAttrs,
githubApp,
mainCount,
importAdded,
)
}
func extractRawObservabilityMap(rawFrontmatter map[string]any) map[string]any {
if rawFrontmatter == nil {
return nil
}
obs, _ := rawFrontmatter["observability"].(map[string]any)
return obs
}
func mergeRawOTLPEndpoints(mainObs map[string]any, importedObs map[string]any) (mergedEndpoints []any, mainCount int, importAdded int) {
seen := make(map[string]struct {
})
for _, ep := range extractRawOTLPEndpointMaps(mainObs) {
if url, _ := ep["url"].(string); url != "" && !setutil.Contains(seen, url) {
seen[url] = struct {
}{}
mergedEndpoints = append(mergedEndpoints, ep)
}
}
mainCount = len(mergedEndpoints)
for _, ep := range extractRawOTLPEndpointMaps(importedObs) {
if url, _ := ep["url"].(string); url != "" && !setutil.Contains(seen, url) {
seen[url] = struct {
}{}
mergedEndpoints = append(mergedEndpoints, ep)
importAdded++
}
}
return mergedEndpoints, mainCount, importAdded
}
func applyMergedRawObservability(
rawFrontmatter map[string]any,
mergedEndpoints []any,
mergedAttrs map[string]string,
mergedResourceAttrs map[string]string,
githubApp map[string]any,
mainCount int,
importAdded int,
) {
if len(mergedEndpoints) == 0 && len(mergedAttrs) == 0 && len(mergedResourceAttrs) == 0 && githubApp == nil {
return
}
newOTLP := map[string]any{}
if len(mergedEndpoints) > 0 {
newOTLP["endpoint"] = mergedEndpoints
}
if len(mergedAttrs) > 0 {
newOTLP["attributes"] = mergedAttrs
}
if len(mergedResourceAttrs) > 0 {
newOTLP["resource-attributes"] = mergedResourceAttrs
}
if githubApp != nil {
newOTLP["github-app"] = githubApp
}
rawFrontmatter["observability"] = map[string]any{"otlp": newOTLP}
orchestratorWorkflowLog.Printf("Merged OTLP endpoints into RawFrontmatter: %d from main workflow, %d from imports (%d total)", mainCount, importAdded, len(mergedEndpoints))
if len(mergedAttrs) > 0 {
orchestratorWorkflowLog.Printf("Merged %d custom OTLP attributes into RawFrontmatter", len(mergedAttrs))
}
if len(mergedResourceAttrs) > 0 {
orchestratorWorkflowLog.Printf("Merged %d OTLP resource attributes into RawFrontmatter", len(mergedResourceAttrs))
}
}
func (c *Compiler) mergeWorkflowEnv(frontmatter map[string]any, workflowData *WorkflowData, importsResult *parser.ImportsResult) error {
topEnv := ExtractMapField(frontmatter, "env")
if importsResult.MergedEnv == "" {
setMainWorkflowEnvSources(workflowData, topEnv)
return nil
}
mergedEnvMap, err := mergeEnv(topEnv, importsResult.MergedEnv)
if err != nil {
return fmt.Errorf("failed to merge env from imports: %w", err)
}
if len(mergedEnvMap) == 0 {
return nil
}
workflowData.Env = c.extractTopLevelYAMLSection(map[string]any{"env": mergedEnvMap}, "env")
workflowData.EnvSources = buildMergedEnvSources(mergedEnvMap, topEnv, importsResult.MergedEnvSources)
return nil
}
func setMainWorkflowEnvSources(workflowData *WorkflowData, topEnv map[string]any) {
if len(topEnv) == 0 {
return
}
envSources := make(map[string]string, len(topEnv))
for key := range topEnv {
envSources[key] = "(main workflow)"
}
workflowData.EnvSources = envSources
}
func buildMergedEnvSources(mergedEnv map[string]any, topEnv map[string]any, importedSources map[string]string) map[string]string {
envSources := make(map[string]string, len(mergedEnv))
for key := range mergedEnv {
if _, inTop := topEnv[key]; inTop {
envSources[key] = "(main workflow)"
} else if src, ok := importedSources[key]; ok {
envSources[key] = src
}
}
return envSources
}
// extractAdditionalConfigurations extracts cache-memory, repo-memory, mcp-scripts, and safe-outputs configurations
func (c *Compiler) extractAdditionalConfigurations(
frontmatter map[string]any,
tools map[string]any,
markdownDir string,
workflowData *WorkflowData,
importsResult *parser.ImportsResult,
markdown string,
safeOutputs *SafeOutputsConfig,
) error {
orchestratorWorkflowLog.Print("Extracting additional configurations")
// Extract cache-memory config and check for errors
cacheMemoryConfig, err := c.extractCacheMemoryConfigFromMap(tools)
if err != nil {
return err
}
workflowData.CacheMemoryConfig = cacheMemoryConfig
// Extract repo-memory config and check for errors
toolsConfig, err := ParseToolsConfig(tools)
if err != nil {
return err
}
repoMemoryConfig, err := c.extractRepoMemoryConfig(toolsConfig, workflowData.WorkflowID)
if err != nil {
return err
}
workflowData.RepoMemoryConfig = repoMemoryConfig
// Extract and process mcp-scripts and safe-outputs
workflowData.Command, workflowData.CommandEvents, workflowData.CommandCentralized, workflowData.CommandPlaceholder = c.extractCommandConfig(frontmatter)
workflowData.LabelCommand, workflowData.LabelCommandEvents, workflowData.LabelCommandDecentralized, workflowData.LabelCommandRemoveLabel = c.extractLabelCommandConfig(frontmatter)
workflowData.Jobs = c.extractJobsFromFrontmatter(frontmatter)
// Merge jobs from imported YAML workflows
if importsResult.MergedJobs != "" && importsResult.MergedJobs != "{}" {
workflowData.Jobs = c.mergeJobsFromYAMLImports(workflowData.Jobs, importsResult.MergedJobs)
}
workflowData.Roles = c.extractRoles(frontmatter)
workflowData.Bots = expandBotNames(mergeBots(c.extractBots(frontmatter), importsResult.MergedBots))
workflowData.LabelNames = c.extractLabelNames(frontmatter)
workflowData.RateLimit = c.extractRateLimitConfig(frontmatter)
workflowData.SkipRoles = mergeSkipRoles(c.extractSkipRoles(frontmatter), importsResult.MergedSkipRoles)
workflowData.SkipBots = expandBotNames(mergeSkipBots(c.extractSkipBots(frontmatter), importsResult.MergedSkipBots))
workflowData.SkipAuthorAssociations = c.extractSkipAuthorAssociations(frontmatter)
workflowData.AllowBotAuthoredTriggerComment = c.extractAllowBotAuthoredTriggerComment(frontmatter)
workflowData.ActivationGitHubToken = c.resolveActivationGitHubToken(frontmatter, importsResult)
workflowData.ActivationGitHubApp = c.resolveActivationGitHubApp(frontmatter, importsResult)
workflowData.TopLevelGitHubApp = resolveTopLevelGitHubApp(frontmatter, importsResult)
// Use the already extracted output configuration
workflowData.SafeOutputs = safeOutputs
// Extract comment-memory from tools and attach to safe-outputs configuration.
// comment-memory now belongs under tools: next to cache-memory and repo-memory.
commentMemoryConfig := c.extractCommentMemoryConfig(toolsConfig)
if commentMemoryConfig != nil {
if workflowData.SafeOutputs == nil {
workflowData.SafeOutputs = &SafeOutputsConfig{}
}
workflowData.SafeOutputs.CommentMemory = commentMemoryConfig
}
// Extract mcp-scripts configuration
workflowData.MCPScripts = c.extractMCPScriptsConfig(frontmatter)
// Merge mcp-scripts from imports
if len(importsResult.MergedMCPScripts) > 0 {
workflowData.MCPScripts = c.mergeMCPScripts(workflowData.MCPScripts, importsResult.MergedMCPScripts)
}
// Extract safe-jobs from safe-outputs.jobs location
topSafeJobs := extractSafeJobsFromFrontmatter(frontmatter)
// Process @include directives to extract additional safe-outputs configurations
includedSafeOutputsConfigs, err := parser.ExpandIncludesForSafeOutputs(markdown, markdownDir)
if err != nil {
return fmt.Errorf("failed to expand includes for safe-outputs: %w", err)
}
// Combine imported safe-outputs with included safe-outputs
var allSafeOutputsConfigs []string
if len(importsResult.MergedSafeOutputs) > 0 {
allSafeOutputsConfigs = append(allSafeOutputsConfigs, importsResult.MergedSafeOutputs...)
}
if len(includedSafeOutputsConfigs) > 0 {
allSafeOutputsConfigs = append(allSafeOutputsConfigs, includedSafeOutputsConfigs...)
}
// Merge safe-jobs from all safe-outputs configurations (imported and included)
includedSafeJobs, err := c.mergeSafeJobsFromIncludedConfigs(topSafeJobs, allSafeOutputsConfigs)
if err != nil {
return fmt.Errorf("failed to merge safe-jobs from includes: %w", err)
}
// Merge app configuration from included safe-outputs configurations
includedApp, err := c.mergeAppFromIncludedConfigs(workflowData.SafeOutputs, allSafeOutputsConfigs)
if err != nil {
return fmt.Errorf("failed to merge app from includes: %w", err)
}
// Ensure SafeOutputs exists and populate the Jobs field with merged jobs
if workflowData.SafeOutputs == nil && len(includedSafeJobs) > 0 {
workflowData.SafeOutputs = &SafeOutputsConfig{}
}
// Always use the merged includedSafeJobs as it contains both main and imported jobs
if workflowData.SafeOutputs != nil && len(includedSafeJobs) > 0 {
workflowData.SafeOutputs.Jobs = includedSafeJobs
}
// Populate the App field if it's not set in the top-level workflow but is in an included config
if workflowData.SafeOutputs != nil && workflowData.SafeOutputs.GitHubApp == nil && includedApp != nil {
workflowData.SafeOutputs.GitHubApp = includedApp
}
// Merge safe-outputs types from imports.
// Pass the raw safe-outputs map from frontmatter so MergeSafeOutputs can distinguish
// between types the user explicitly configured and types that were auto-defaulted by
// extractSafeOutputsConfig. Without this, auto-defaults (e.g. threat-detection) would
// prevent imported configurations for those types from being merged.
rawSafeOutputsMap, _ := frontmatter["safe-outputs"].(map[string]any)
mergedSafeOutputs, err := c.MergeSafeOutputs(workflowData.SafeOutputs, allSafeOutputsConfigs, rawSafeOutputsMap)
if err != nil {
return fmt.Errorf("failed to merge safe-outputs from imports: %w", err)
}
workflowData.SafeOutputs = mergedSafeOutputs
// Apply default threat detection when safe-outputs came entirely from imports/includes
// (i.e. the main frontmatter has no safe-outputs: section). In this case the merge
// produces a non-nil SafeOutputs but leaves ThreatDetection nil, which would suppress
// the detection gate on the safe_outputs job. Mirroring the behaviour of
// extractSafeOutputsConfig for direct frontmatter declarations, we enable detection by
// default unless any imported config explicitly sets threat-detection: false.
if safeOutputs == nil && workflowData.SafeOutputs != nil && workflowData.SafeOutputs.ThreatDetection == nil {
if !isThreatDetectionExplicitlyDisabledInConfigs(allSafeOutputsConfigs) {
orchestratorWorkflowLog.Print("Applying default threat-detection for safe-outputs assembled from imports/includes")
workflowData.SafeOutputs.ThreatDetection = &ThreatDetectionConfig{}
}
}
// Auto-inject create-issues if safe-outputs is configured but has no non-builtin outputs.
// This ensures every workflow with safe-outputs has at least one meaningful action handler.
applyDefaultCreateIssue(workflowData)
// Apply the top-level github-app as a fallback for all nested github-app token minting operations.
// This runs last so that all section-specific configurations have been resolved first.
applyTopLevelGitHubAppFallbacks(workflowData)
// Extract experiments configuration once; derive the simple variants map from the configs.
workflowData.ExperimentConfigs = extractExperimentConfigsFromFrontmatter(frontmatter)
workflowData.Experiments = experimentVariantsFromConfigs(workflowData.ExperimentConfigs)
workflowData.ExperimentsStorage = extractExperimentsStorageFromFrontmatter(frontmatter)
return nil
}
// mergeImportedOnFields copies import-safe on.* fields from imports into the main workflow frontmatter.
// Top-level on.* fields in the main workflow always take precedence.
func (c *Compiler) mergeImportedOnFields(frontmatter map[string]any, workflowData *WorkflowData, importsResult *parser.ImportsResult) error {
if importsResult == nil {
return nil
}
onMap := ensureOnMap(frontmatter)
if onMap == nil {
return nil
}
if _, exists := onMap["skip-if-match"]; !exists && importsResult.MergedSkipIfMatch != "" {
var value any
if err := json.Unmarshal([]byte(importsResult.MergedSkipIfMatch), &value); err != nil {
return fmt.Errorf("failed to parse imported on.skip-if-match value: %w", err)
}
onMap["skip-if-match"] = value
if workflowData != nil && workflowData.ParsedFrontmatter != nil {
if workflowData.ParsedFrontmatter.On == nil {
workflowData.ParsedFrontmatter.On = make(map[string]any)
}
workflowData.ParsedFrontmatter.On["skip-if-match"] = value
}
}
if _, exists := onMap["skip-if-no-match"]; !exists && importsResult.MergedSkipIfNoMatch != "" {
var value any
if err := json.Unmarshal([]byte(importsResult.MergedSkipIfNoMatch), &value); err != nil {
return fmt.Errorf("failed to parse imported on.skip-if-no-match value: %w", err)
}
onMap["skip-if-no-match"] = value
if workflowData != nil && workflowData.ParsedFrontmatter != nil {
if workflowData.ParsedFrontmatter.On == nil {
workflowData.ParsedFrontmatter.On = make(map[string]any)
}
workflowData.ParsedFrontmatter.On["skip-if-no-match"] = value
}
}
return nil
}
func ensureOnMap(frontmatter map[string]any) map[string]any {
if frontmatter == nil {
return nil
}
onValue, exists := frontmatter["on"]
if !exists {
on := make(map[string]any)
frontmatter["on"] = on
return on
}
onMap, ok := onValue.(map[string]any)
if ok {
return onMap
}
return nil
}
// processOnSectionAndFilters processes the on section configuration and applies various filters
func (c *Compiler) processOnSectionAndFilters(
frontmatter map[string]any,
workflowData *WorkflowData,
cleanPath string,
) error {
orchestratorWorkflowLog.Print("Processing on section and filters")
// Process stop-after configuration from the on: section
if err := c.processStopAfterConfiguration(frontmatter, workflowData, cleanPath); err != nil {
return err
}
// Process skip-if-match configuration from the on: section
if err := c.processSkipIfMatchConfiguration(frontmatter, workflowData); err != nil {
return err
}
// Process skip-if-no-match configuration from the on: section
if err := c.processSkipIfNoMatchConfiguration(frontmatter, workflowData); err != nil {
return err
}
// Process skip-if-check-failing configuration from the on: section
if err := c.processSkipIfCheckFailingConfiguration(frontmatter, workflowData); err != nil {
return err
}
// Process manual-approval configuration from the on: section
if err := c.processManualApprovalConfiguration(frontmatter, workflowData); err != nil {
return err
}
// Parse the "on" section for command triggers, reactions, and other events
if err := c.parseOnSection(frontmatter, workflowData, cleanPath); err != nil {
return err
}
// Apply defaults
if err := c.applyDefaults(workflowData, cleanPath); err != nil {
return err
}
// Apply pull request draft filter if specified
c.applyPullRequestDraftFilter(workflowData, frontmatter)
// Apply pull request fork filter if specified
c.applyPullRequestForkFilter(workflowData, frontmatter)
// Apply label filter if specified
c.applyLabelFilter(workflowData, frontmatter)
// Extract on.steps for pre-activation step injection
onSteps, err := extractOnSteps(frontmatter)
if err != nil {
return err
}
// Apply action pinning to on.steps
if len(onSteps) > 0 {
anySteps := make([]any, len(onSteps))
for i, s := range onSteps {
anySteps[i] = s
}
typedSteps, convErr := SliceToSteps(anySteps)
if convErr == nil {
typedSteps, convErr = applyActionPinsToTypedSteps(typedSteps, workflowData)
if convErr != nil {
return fmt.Errorf("on.steps: %w", convErr)
}
for i, s := range typedSteps {
onSteps[i] = s.ToMap()
}
} else {
orchestratorWorkflowLog.Printf("Failed to convert on.steps to typed steps for action pinning: %v", convErr)
}
}
workflowData.OnSteps = onSteps
// Extract on.permissions for pre-activation job permissions
workflowData.OnPermissions = extractOnPermissions(frontmatter)
// Extract on.needs for pre-activation/activation job dependencies
onNeeds, err := extractOnNeeds(frontmatter)
if err != nil {
return err
}
workflowData.OnNeeds = onNeeds
return nil
}