Skip to content

[deep-report] Enrich schema descriptions for redirect (placeholder behavior) and tracker-id (searchability contract) #57378

Description

@github-actions

Description

Schema Consistency Checker's 2026-08-31 report (discussion #57357) found two schema-description gaps distinct from prior closures (#54179/#54400 covered docs/frontmatter.md, not main_workflow_schema.json; #54456 added tracker-id's minLength/maxLength/pattern constraints, which are already present, but not the behavior description):

  1. redirect's schema description (main_workflow_schema.json — currently: "Optional workflow location redirect for updates... When present, update follows this location and rewrites source.") only describes it as an update-location pointer. It doesn't mention that redirect: + a missing on: field is a special compile-time placeholder that gh aw compile skips with an informational message rather than compiling a runnable workflow (pkg/workflow/compiler_orchestrator_workflow.go:70, pkg/workflow/compiler_string_api.go:100-103) — a behavior already documented in docs/reference/frontmatter.md:713-718 but missing from the schema text.
  2. tracker-id's schema description validates pattern/length but doesn't mention that the identifier is injected as a hidden HTML comment footer on created assets and is searchable via GitHub queries (docs/reference/frontmatter.md:720-733, pkg/workflow/frontmatter_extraction_metadata.go:122-161) — schema-generated docs under-specify this operational/searchability contract.

Expected Impact

Brings schema-generated reference text (frontmatter-full.md) in line with the richer behavior already documented in the hand-written docs, so schema-only tooling/readers don't miss the redirect placeholder control-flow behavior or the tracker-id searchability contract.

Suggested Agent

General-purpose agent — expand the redirect and tracker-id field descriptions in pkg/parser/schemas/main_workflow_schema.json to match the behavior already documented in docs/src/content/docs/reference/frontmatter.md (lines 713-718 and 720-733 respectively).

Estimated Effort

Quick (< 1 hour, description-text-only change)

Data Source

DeepReport Intelligence analysis, 2026-08-31 cycle, from Schema Consistency Checker discussion #57357 ("Documentation Gaps" items 1-2).

Warning

Firewall blocked 1 domain

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

  • api.anthropic.com

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

network:
  allowed:
    - defaults
    - "api.anthropic.com"

See Network Configuration for more information.

Generated by 🔬 Deep Report · claude · agent · 435.8 AIC · ⌖ 10.5 AIC · ⊞ 12.4K ·

  • expires on Sep 1, 2026, 11:06 PM UTC-08:00

Activity

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