Fix unusable strategy schema for custom jobs + add compiler extraction (Option B)#19405
Merged
Fix unusable strategy schema for custom jobs + add compiler extraction (Option B)#19405
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix empty strategy schema for custom jobs
Fix unusable strategy schema for custom jobs + add compiler extraction (Option B)
Mar 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes custom job strategy support by making the schema accept real strategy objects and ensuring the compiler extracts/renders strategy so it round-trips into the generated workflow YAML.
Changes:
- Updated the main workflow JSON schema to allow
strategy.matrix,strategy.fail-fast, andstrategy.max-parallelfor custom jobs. - Added
Strategyto theJobmodel and rendered it in job YAML output. - Extracted
strategyfrom custom job frontmatter during compilation and added a compiler test.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| pkg/parser/schemas/main_workflow_schema.json | Fixes the custom jobs strategy schema so non-empty strategy objects validate. |
| pkg/workflow/jobs.go | Adds Job.Strategy and renders it after runs-on. |
| pkg/workflow/compiler_jobs.go | Extracts strategy from custom jobs and formats it into job YAML. |
| pkg/workflow/compiler_jobs_test.go | Adds a test exercising custom job strategy compilation output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+497
to
+515
| // Extract strategy for custom jobs | ||
| if strategy, hasStrategy := configMap["strategy"]; hasStrategy { | ||
| if strategyMap, ok := strategy.(map[string]any); ok { | ||
| // Use goccy/go-yaml to marshal strategy | ||
| yamlBytes, err := yaml.Marshal(strategyMap) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to convert strategy to YAML for job '%s': %w", jobName, err) | ||
| } | ||
| // Indent the YAML properly for job-level strategy | ||
| strategyYAML := string(yamlBytes) | ||
| lines := strings.Split(strings.TrimSpace(strategyYAML), "\n") | ||
| var formattedStrategy strings.Builder | ||
| formattedStrategy.WriteString("strategy:\n") | ||
| for _, line := range lines { | ||
| formattedStrategy.WriteString(" " + line + "\n") | ||
| } | ||
| job.Strategy = formattedStrategy.String() | ||
| } | ||
| } |
There was a problem hiding this comment.
The strategy extraction duplicates the same marshal/indent logic used for permissions just above. This kind of copy/paste tends to diverge over time (formatting, error handling, indentation rules). Consider factoring this into a small helper (e.g., marshalJobSection(name string, v any) (string, error)) and use it for both permissions and strategy to keep behavior consistent.
Contributor
There was a problem hiding this comment.
@copilot refactor the strategy type in the JSON schema
Contributor
Author
There was a problem hiding this comment.
Done in 2140137 — extracted the inline strategy object definition into a named $defs/job_strategy type and replaced the inline definition with "$ref": "#/$defs/job_strategy", following the same pattern as other reusable types in the schema.
Comment on lines
+2252
to
+2273
| // Verify matrix_job has strategy section | ||
| if !strings.Contains(yamlStr, "matrix_job:") { | ||
| t.Error("Expected matrix_job in compiled output") | ||
| } | ||
| if !strings.Contains(yamlStr, "strategy:") { | ||
| t.Error("Expected strategy section in compiled output") | ||
| } | ||
| if !strings.Contains(yamlStr, "matrix:") { | ||
| t.Error("Expected matrix section in compiled output") | ||
| } | ||
| if !strings.Contains(yamlStr, "fail-fast: false") { | ||
| t.Error("Expected fail-fast: false in compiled output") | ||
| } | ||
| if !strings.Contains(yamlStr, "max-parallel: 2") { | ||
| t.Error("Expected max-parallel: 2 in compiled output") | ||
| } | ||
|
|
||
| // Verify simple_job has no strategy | ||
| if !strings.Contains(yamlStr, "simple_job:") { | ||
| t.Error("Expected simple_job in compiled output") | ||
| } | ||
| } |
There was a problem hiding this comment.
This test only checks strings.Contains on the entire lock file, which is brittle and can give false positives (e.g., if "strategy:" appears elsewhere in the workflow) and it doesn't actually verify that simple_job doesn't get a strategy block. A more reliable assertion would be to yaml.Unmarshal the compiled lock YAML and then check that jobs.matrix_job.strategy exists with the expected subfields, and that jobs.simple_job has no strategy key.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
|
@copilot merge main, recompile |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done in bed224d — merged main, resolved the conflict in Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Contributor
|
@copilot merge main and recompile |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done in 54ea865 — merged main (4 new commits including Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
strategyschema inpkg/parser/schemas/main_workflow_schema.jsonwith propermatrix,fail-fast,max-parallelpropertiesstrategyinline object into a named$defs/job_strategytype referenced via$refStrategy stringfield toJobstruct inpkg/workflow/jobs.gostrategyinbuildCustomJobs()inpkg/workflow/compiler_jobs.gousing YAML marshal (same pattern aspermissions)StrategyinrenderJob()inpkg/workflow/jobs.goTestBuildCustomJobsWithStrategytest for strategy round-trip compilationmake buildafter schema changesTestBuildCustomJobsWithStrategyandTestBuildCustomJobsRunsOnForms)Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.