Skip to content

Add JSON schema examples for safe-outputs configuration #2580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Oct 27, 2025
Merged

Add JSON schema examples for safe-outputs configuration #2580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
722a368
Initial plan
Copilot Oct 26, 2025
1ae401e
Add examples for safe-outputs configuration in schema
Copilot Oct 26, 2025
46f5971
chore: add changeset for safe-outputs schema examples [skip-ci]
github-actions[bot] Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/patch-add-safe-outputs-schema-examples.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

68 changes: 62 additions & 6 deletions pkg/parser/schemas/main_workflow_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2077,7 +2077,22 @@
"description": "GitHub token to use for this specific output type. Overrides global github-token if specified."
}
},
"additionalProperties": false
"additionalProperties": false,
"examples": [
{
"title-prefix": "[ca] ",
"labels": ["automation", "dependencies"],
"assignees": "copilot"
},
{
"title-prefix": "[duplicate-code] ",
"labels": ["code-quality", "automated-analysis"],
"assignees": "copilot"
},
{
"min": 1
}
]
},
{
"type": "null",
Expand Down Expand Up @@ -2168,7 +2183,20 @@
"description": "GitHub token to use for this specific output type. Overrides global github-token if specified."
}
},
"additionalProperties": false
"additionalProperties": false,
"examples": [
{
"category": "audits"
},
{
"title-prefix": "[copilot-agent-analysis] ",
"category": "audits",
"max": 1
},
{
"category": "General"
}
]
},
{
"type": "null",
Expand Down Expand Up @@ -2212,7 +2240,16 @@
"description": "Target discussion comments instead of issue/PR comments. Must be true if present."
}
},
"additionalProperties": false
"additionalProperties": false,
"examples": [
{
"max": 1,
"target": "*"
},
{
"max": 3
}
]
},
{
"type": "null",
Expand Down Expand Up @@ -2275,7 +2312,20 @@
"description": "GitHub token to use for this specific output type. Overrides global github-token if specified."
}
},
"additionalProperties": false
"additionalProperties": false,
"examples": [
{
"title-prefix": "[docs] ",
"labels": ["documentation", "automation"],
"reviewers": "copilot",
"draft": false
},
{
"title-prefix": "[security-fix] ",
"labels": ["security", "automated-fix"],
"reviewers": "copilot"
}
]
},
{
"type": "null",
Expand Down Expand Up @@ -2599,7 +2649,8 @@
},
"staged": {
"type": "boolean",
"description": "If true, emit step summary messages instead of making GitHub API calls (preview mode)"
"description": "If true, emit step summary messages instead of making GitHub API calls (preview mode)",
"examples": [true, false]
},
"env": {
"type": "object",
Expand All @@ -2614,7 +2665,12 @@
},
"github-token": {
"$ref": "#/$defs/github_token",
"description": "GitHub token to use for safe output jobs. Typically a secret reference like ${{ secrets.GITHUB_TOKEN }} or ${{ secrets.CUSTOM_PAT }}"
"description": "GitHub token to use for safe output jobs. Typically a secret reference like ${{ secrets.GITHUB_TOKEN }} or ${{ secrets.CUSTOM_PAT }}",
"examples": [
"${{ secrets.GITHUB_TOKEN }}",
"${{ secrets.CUSTOM_PAT }}",
"${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}"
]
},
"max-patch-size": {
"type": "integer",
Expand Down
Loading