Skip to content

[deep-report] [quick-win] Document the user-invokable ignored frontmatter field for Copilot custom-agent interop #35506

@github-actions

Description

@github-actions

Source

Surfaced by today's Schema Consistency Check audit (#35425).

What

pkg/constants/constants.go:309 declares:

IgnoredFrontmatterFields = []string{"user-invokable"}

The code comment explains: user-invokable is a GitHub Copilot custom agent field that is not part of the gh-aw schema. The compiler silently strips it so authors can ship a single markdown that serves as both a gh-aw workflow and a Copilot custom agent.

A grep -r "user-invokable" docs/ returns zero hits. Authors who want to use this interop escape hatch have no way to discover it without reading constants.go.

Action

Add a short "Interoperability with Copilot custom agents" note under docs/src/content/docs/reference/frontmatter.md (or wherever the ignored-field policy fits best) that:

  1. Lists the fields in IgnoredFrontmatterFields (currently just user-invokable).
  2. Explains why each is tolerated.
  3. Links back to GitHub Copilot's custom-agent documentation.

Impact

Low-effort docs change; closes a hidden-affordance gap; valuable for the growing population of users running gh-aw alongside Copilot custom agents.

Suggested agent

Doc-focused agent (e.g., spec-enforcer or doc-writer) — < 1 hour.

References

Generated by 🔬 DeepReport - Intelligence Gathering Agent · opus47 19.3M ·

  • expires on May 30, 2026, 4:08 PM UTC

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions