Skip to content

[Code Quality] Document dispatch_repository snake_case naming exception in frontmatter.md concise reference #47132

Description

@github-actions

Description

The 2026-07-21 Schema Consistency Check (#46991) flagged that the dispatch_repository nested keys (event_type, allowed_repositories) are snake_case-only while most other frontmatter keys are kebab-case. This exception is documented in frontmatter-full.md and the schema, but the concise frontmatter reference (docs/src/content/docs/reference/frontmatter.md) does not mention it.

This is a user-facing footgun: someone reading the concise reference will naturally reach for event-type / allowed-repositories (kebab-case), have the workflow silently fail, and only discover the exception by reading the full reference.

Suggested Changes

  • In docs/src/content/docs/reference/frontmatter.md, add a callout or note near the dispatch_repository section explaining:
    • That nested keys under dispatch_repository use snake_case (not kebab-case)
    • The correct spellings: event_type and allowed_repositories
    • Optionally, a short example snippet showing the correct form
  • If no dispatch_repository section exists in the concise reference, add a minimal entry with the naming note

Files Affected

  • docs/src/content/docs/reference/frontmatter.md (add snake_case callout near dispatch_repository)

Success Criteria

  • frontmatter.md documents the snake_case exception for dispatch_repository nested keys
  • A reader of the concise reference can correctly write event_type / allowed_repositories without consulting frontmatter-full.md
  • No changes to parser or runtime behavior

Source

Extracted from Schema Consistency Check - 2026-07-21 (#46991)

Priority

Medium — Prevents silent misconfiguration; users routinely read the concise reference first

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · sonnet46 54.4 AIC · ⌖ 8.42 AIC · ⊞ 7.1K ·

  • expires on Jul 22, 2026, 11:13 AM UTC-08:00

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions