schema: allow `required-category` in `safe-outputs.create-discussion` and add regression coverage by Copilot · Pull Request #39640 · github/gh-aw

Copilot · 2026-06-16T18:21:23Z

CreateDiscussionsConfig supports required-category, but the create-discussion schema branch did not declare it while enforcing additionalProperties: false. That caused valid configs using close-older-discussions + required-category to fail strict validation.

Schema alignment
- Updated /home/runner/work/gh-aw/gh-aw/pkg/parser/schemas/main_workflow_schema.json to include required-category in safe-outputs.create-discussion.properties.
- Kept it grouped with the close-older-* controls it influences.
Schema examples
- Extended create-discussion.examples to show required-category used with close-older-discussions, so editor/schema consumers surface the intended pairing.
Regression coverage
- Added TestMainWorkflowSchema_CreateDiscussionRequiredCategoryAllowed in /home/runner/work/gh-aw/gh-aw/pkg/parser/schema_test.go to assert this config validates successfully.

safe-outputs:
  create-discussion:
    category: reports
    close-older-discussions: true
    required-category: reports

github-actions · 2026-06-16T18:33:55Z

Hey @Copilot 👋 — thanks for picking up this schema consistency fix! Aligning required-category under the create-discussion branch in main_workflow_schema.json is a clean, well-scoped change and the issue writeup gives strong context to work from.

This PR is still a [WIP] draft with no files changed yet, so a couple of things to keep in mind before it's ready for review:

Add the schema change — pkg/parser/schemas/main_workflow_schema.json needs required-category (string) added to the create-discussion object branch (around line 5621), matching the pattern already used under close-discussion (~line 5808). The schema must remain additionalProperties: false.
Add or update tests — once the schema is updated, a test that validates a create-discussion config containing required-category should be added (or updated if one already exists) to confirm strict schema validation passes.
Update the PR description — replace the placeholder opening with a concrete summary of what was changed and why, so reviewers have a quick orientation.

If you need a nudge on the implementation, here's a ready-to-use prompt:

Fix the schema inconsistency described in issue #39598:
1. Open pkg/parser/schemas/main_workflow_schema.json.
2. Locate the `create-discussion` object branch (around line 5621, additionalProperties: false).
3. Add a `required-category` property (type: string) to that branch, mirroring the definition already present under the `close-discussion` branch (~line 5808).
4. Add or update a test (likely in pkg/parser/ or a schema validation test file) that exercises a `create-discussion` config with `required-category` set and asserts it passes strict schema validation.
5. Update the PR body with a short summary of what was changed and why.

Generated by ✅ Contribution Check · ◷

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot

Pull request overview

This pull request fixes strict schema validation for safe-outputs.create-discussion by adding the missing required-category property to the create-discussion schema branch (which has additionalProperties: false). This aligns the JSON schema with CreateDiscussionsConfig, enabling workflows to configure category filtering when close-older-discussions is enabled.

Changes:

Extend safe-outputs.create-discussion schema to accept required-category: <string>.
Document the field inline in the schema with a description matching its close-older-discussions filtering behavior.

Show a summary per file

File	Description
pkg/parser/schemas/main_workflow_schema.json	Adds `required-category` to `create-discussion` properties so strict validation permits the config used by close-older-discussions filtering.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 1/1 changed files
Comments generated: 0

github-actions · 2026-06-16T20:27:40Z

✅ Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. The only changed file is pkg/parser/schemas/main_workflow_schema.json (4 additions, 0 deletions — a JSON schema update). Test Quality Sentinel skipped.

github-actions · 2026-06-16T20:27:50Z

✅ Design Decision Gate 🏗️ completed the design decision gate check.

No ADR enforcement needed: PR #39640 does not have the 'implementation' label and has only 4 new lines of code in business logic directories (threshold is 100). Neither Condition A nor Condition B is met.

github-actions · 2026-06-16T20:28:44Z

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

github-actions

Skills-Based Review 🧠

Applied /tdd, /diagnose, and /grill-with-docs — approving. The fix is correct and surgical; two minor follow-ups suggested.

📋 Key Themes & Highlights

Key Themes

Missing regression test: The fix is not covered by a schema-validation test. Given additionalProperties: false, this field could silently disappear again in a future schema regeneration pass and nothing would catch it until a user hit the validation error.
Missing example: The create-discussion examples block does not demonstrate required-category; close-discussion already has one. A short addition would close the documentation gap.

Positive Highlights

✅ Correct placement — new field is positioned adjacent to close-older-key and the other close-older-* fields, making the grouping clear.
✅ Description is precise — explains both what the field does and when it applies (close-older-discussions being enabled).
✅ Minimal change — 4 lines, zero deletions, no logic touched. Exactly the right scope for a schema bug fix.
✅ Consistent with close-discussion.required-category — type declaration mirrors the twin field in the sibling branch.

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer

github-actions · 2026-06-16T20:36:06Z

                  "minLength": 1,
                  "pattern": "\\S"
                },
+                "required-category": {


[/tdd] This bug fix lacks a regression test — the same copy-omission could silently re-appear.

💡 Suggested test

A targeted schema-validation test (similar to safe_outputs_error_location_test.go) would anchor the fix:

{ name: "create-discussion with required-category is valid", yamlContent: `on: daily safe-outputs: create-discussion: category: Ideas close-older-discussions: true required-category: Ideas`, expectValid: true, description: "required-category must be accepted in create-discussion branch", },

Without it, the field could be silently dropped from the schema again (e.g., during a bulk property-list regeneration) and no test would catch it.

Added a regression test in /home/runner/work/gh-aw/gh-aw/pkg/parser/schema_test.go (TestMainWorkflowSchema_CreateDiscussionRequiredCategoryAllowed) that validates safe-outputs.create-discussion.required-category passes strict schema validation with close-older-discussions: true.

github-actions · 2026-06-16T20:36:06Z

                },
+                "required-category": {
+                  "type": "string",
+                  "description": "Required category for matching when close-older-discussions is enabled. Only discussions in this category will be considered when searching for older discussions to close."


[/grill-with-docs] The examples array for create-discussion (further down in the file) does not include a required-category usage example, even though close-discussion already has one (required-category: "Ideas"). A short example alongside close-older-discussions: true would make the intended pairing obvious to users.

💡 Suggested addition to examples

{ "title-prefix": "[weekly-report] ", "category": "Ideas", "close-older-discussions": true, "required-category": "Ideas" }

This directly mirrors the motivating use-case from the PR description and helps schema-aware editors surface the field when close-older-discussions is set.

Added the requested example in /home/runner/work/gh-aw/gh-aw/pkg/parser/schemas/main_workflow_schema.json under create-discussion.examples to show required-category alongside close-older-discussions: true.

pelikhan · 2026-06-16T21:05:00Z

@copilot run pr-finisher skill
fix https://github.com/github/gh-aw/actions/runs/27645105661/job/81757689329?pr=39640

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Initial plan

3c53aa5

Copilot AI assigned Copilot and pelikhan Jun 16, 2026

Copilot started work on behalf of pelikhan June 16, 2026 18:36 View session

Add required-category to create-discussion schema branch

f048de7

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add required-category to create-discussion schema~~ schema: add required-category to create-discussion branch Jun 16, 2026

Copilot finished work on behalf of pelikhan June 16, 2026 18:45

Copilot AI requested a review from pelikhan June 16, 2026 18:45

github-actions Bot mentioned this pull request Jun 16, 2026

[PR Triage Report] 🤖 PR Triage Report — 2026-06-16 (Run §27642308894) #39659

Closed

pelikhan marked this pull request as ready for review June 16, 2026 20:12

Copilot AI review requested due to automatic review settings June 16, 2026 20:12

Copilot started reviewing on behalf of pelikhan June 16, 2026 20:13 View session

Copilot AI reviewed Jun 16, 2026

View reviewed changes

github-actions Bot mentioned this pull request Jun 16, 2026

[aw] No-Op Runs #38951

Closed

github-actions Bot approved these changes Jun 16, 2026

View reviewed changes

Copilot started work on behalf of pelikhan June 16, 2026 21:05 View session

Copilot finished work on behalf of pelikhan June 16, 2026 21:27

Copilot started work on behalf of pelikhan June 16, 2026 21:27 View session

Add create-discussion required-category coverage

52418f9

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~schema: add required-category to create-discussion branch~~ schema: allow required-category in safe-outputs.create-discussion and add regression coverage Jun 16, 2026

Copilot finished work on behalf of pelikhan June 16, 2026 21:46

pelikhan merged commit 46f9688 into main Jun 16, 2026
36 checks passed

pelikhan deleted the copilot/deep-report-add-required-category branch June 16, 2026 22:51

Copilot AI mentioned this pull request Jun 18, 2026

Surface recent AWF schema features in canonical docs and regenerate frontmatter reference #39956

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

schema: allow `required-category` in `safe-outputs.create-discussion` and add regression coverage#39640

schema: allow `required-category` in `safe-outputs.create-discussion` and add regression coverage#39640
pelikhan merged 3 commits into
mainfrom
copilot/deep-report-add-required-category

Copilot AI commented Jun 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 16, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Jun 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot left a comment

Uh oh!

github-actions Bot Jun 16, 2026

Uh oh!

Copilot AI Jun 16, 2026

Uh oh!

github-actions Bot Jun 16, 2026

Uh oh!

Copilot AI Jun 16, 2026

Uh oh!

pelikhan commented Jun 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

github-actions Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Skills-Based Review 🧠

Key Themes

Positive Highlights

Uh oh!

github-actions Bot Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Jun 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jun 16, 2026 •

edited

Loading

github-actions Bot commented Jun 16, 2026 •

edited

Loading

github-actions Bot commented Jun 16, 2026 •

edited

Loading

github-actions Bot commented Jun 16, 2026 •

edited

Loading