Skip to content

[Code Quality] Demote deprecated safe-outputs.dispatch_repository alias in generated frontmatter-full.md #48801

Description

@github-actions

Description

pkg/workflow/dispatch_repository.go treats dispatch-repository (kebab-case) as canonical and logs a deprecation warning when the legacy dispatch_repository alias is used. The schema (pkg/parser/schemas/main_workflow_schema.json) correctly labels dispatch_repository as deprecated, but the generated reference doc docs/src/content/docs/reference/frontmatter-full.md (around line 9101) still renders a full, prominent top-level example block for the deprecated alias immediately after the canonical one, giving it equal visual weight.

Suggested Changes

  • Update the doc-generation logic (or the schema description consumed by it) so deprecated aliases like dispatch_repository are rendered as a brief "deprecated alias" note rather than a full duplicate example block.
  • Regenerate frontmatter-full.md and verify the deprecated alias is clearly de-emphasized relative to the canonical dispatch-repository key.

Files Affected

  • docs/src/content/docs/reference/frontmatter-full.md (generated, ~line 9101)
  • Doc-generation source/templates that produce this section (likely under pkg/parser/schemas/ tooling or docs generation scripts)

Success Criteria

  • Deprecated dispatch_repository alias no longer has a full duplicate top-level example block in generated docs.
  • Canonical dispatch-repository remains fully documented; deprecated alias is documented only briefly with a pointer to the canonical form.

Source

Extracted from Schema Consistency Check discussion #48781

Priority

Low-Medium - cosmetic/doc-clarity issue, not a functional bug.

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · sonnet50 · 29.8 AIC · ⌖ 4.66 AIC · ⊞ 9.8K · ◷

  • expires on Jul 29, 2026, 11:42 PM UTC-08:00

Activity

  1. github-actions commented on Jul 30, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-07-30T07:42:16.973Z.

    Closed by Workflow

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

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