Skip to content

[schema-coverage] feat: Add schema coverage demo for check-for-updates field#32976

Merged
pelikhan merged 1 commit into
mainfrom
schema-coverage-check-for-updates-b7df420f81ab5976
May 18, 2026
Merged

[schema-coverage] feat: Add schema coverage demo for check-for-updates field#32976
pelikhan merged 1 commit into
mainfrom
schema-coverage-check-for-updates-b7df420f81ab5976

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Schema Coverage Demo

This PR adds a minimal demo workflow that demonstrates usage of the check-for-updates field in the gh-aw frontmatter schema.

Why: The schema feature coverage checker found that check-for-updates was not used in any existing workflow.

What: Adds schema-demos/schema-demo-check-for-updates.md with a valid, minimal demonstration of this field.

Field Description

Control whether the compile-agentic version update check runs in the activation job. When true (default), the activation job downloads config.json from the gh-aw repository and verifies the compiled version is not blocked and meets the minimum supported version. Set to false to disable the check (not allowed in strict mode). See: https://github.github.com/gh-aw/reference/frontmatter/#check-for-updates

Validation

  • Coverage grep confirms schema-demos/schema-demo-check-for-updates.md now contains the top-level check-for-updates key.
  • make build && make fmt could not complete because this runner has Go 1.24.13 locally, while go.mod requires Go 1.25.8, and the toolchain download from proxy.golang.org is blocked by the environment firewall.
  • make fmt is blocked by the same missing Go 1.25.8 toolchain.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • proxy.golang.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "proxy.golang.org"

See Network Configuration for more information.

Generated by 📊 Schema Feature Coverage Checker ·

  • expires on May 25, 2026, 7:55 AM UTC

@pelikhan pelikhan marked this pull request as ready for review May 18, 2026 12:37
Copilot AI review requested due to automatic review settings May 18, 2026 12:37
@pelikhan pelikhan merged commit 06d198d into main May 18, 2026
4 checks passed
@pelikhan pelikhan deleted the schema-coverage-check-for-updates-b7df420f81ab5976 branch May 18, 2026 12:37
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new schema demo workflow markdown file to cover the previously-unused top-level frontmatter field check-for-updates for the schema coverage checker.

Changes:

  • Add schema-demos/schema-demo-check-for-updates.md demonstrating the check-for-updates frontmatter key.
  • Document (in-file) what the field does and provide a minimal noop task payload.
Show a summary per file
File Description
schema-demos/schema-demo-check-for-updates.md Adds a minimal schema demo file exercising the check-for-updates frontmatter field for coverage.

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: 1

Comment on lines +7 to +9
engine: codex
check-for-updates: false
timeout-minutes: 5
@github-actions github-actions Bot mentioned this pull request May 18, 2026
Copy link
Copy Markdown
Contributor Author

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skills-Based Review 🧠

Applied /grill-with-docs — this PR adds a new schema demo file and the key question is whether it accurately represents the domain language and typical usage.

Key Observations

  • Demo shows the false (non-default) value: The demo sets check-for-updates: false, which per the PR description is "not allowed in strict mode". A reader learning from this demo would see the unusual/restricted form rather than the recommended true default. Consider either demonstrating true (the default, recommended value) or adding an inline comment in the markdown explaining that false is intentionally chosen here to show the field exists (and linking to the strict-mode caveat).
  • Self-referential task prompt: The workflow body instructs the agent to call noop with a hardcoded JSON block, which is a reasonable pattern for a coverage-only demo — this is consistent with other schema-demos/ files.

Positive Highlights

  • ✅ Minimal and well-scoped — exactly one field demonstrated, no unnecessary complexity
  • ✅ Frontmatter is valid and correctly structured
  • ✅ Clear comment that this is a coverage-only demo

Verdict

No blocking issues. The one thing worth considering before merge is whether false is the right value to demo (see inline comment).

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · ● 3.2M

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants