You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The daily AWF spec-compiler surfacing review found that several user-facing AWF schema capabilities merged in the last 7 days are not surfaced in the documentation. The root cause is that the auto-generated frontmatter reference is stale, plus a couple of features lack any hand-written coverage.
This is the first run of the surfacing reviewer (no prior state), so the diff window was built from the GitHub API over the last 7 days.
Core finding: generated frontmatter reference is stale
docs/src/content/docs/reference/frontmatter-full.md is auto-generated from the JSON Schema (make generate-schema-docs → node scripts/generate-schema-docs.js), but it is out of sync with the current schema. It documents every observability.otlp key except the newly added resource-attributes, and is also missing normalize-closing-keywords and format-json.
Evidence
Schema path confirmed present: properties/observability/properties/otlp/properties/resource-attributes in pkg/parser/schemas/main_workflow_schema.json.
Compiler implementation of resource-attributes: pkg/workflow/observability_otlp.go, pkg/workflow/compiler_orchestrator_workflow.go, pkg/workflow/frontmatter_types.go.
Follow-up tasks
1. Regenerate the schema-derived frontmatter reference — Priority: HIGH
Run make generate-schema-docs and commit the refreshed docs/src/content/docs/reference/frontmatter-full.md. This mechanically picks up resource-attributes, normalize-closing-keywords, and format-json. Consider a CI check that fails when the generated doc drifts from the schema, to prevent recurrence.
2. Document observability.otlp.resource-attributes in hand-written docs — Priority: HIGH
Feature (#39636): additional OTEL_RESOURCE_ATTRIBUTES entries appended to the standard gh-aw/GitHub resource attributes; values may be static strings or GitHub Actions expressions; must not use secrets.* / vars.* (exported to external tracing backends, not treated as secret). Add coverage to the observability section of .github/aw/syntax-agentic.md (already documents OTLP) and the relevant hand-written observability/audit reference, including the no-secrets safety note.
3. Document normalize-closing-keywords in canonical safe-outputs docs — Priority: MEDIUM
Feature (#39643): when true, strips backticks from recognized issue-closing keywords (e.g. `Closes #1` → Closes #1) in body fields. Applies to create-issue, add-comment, and create-pull-request. Currently only referenced in docs/.../experimental/safe-outputs-samples.md. Add it to the canonical safe-outputs reference and the agent-facing .github/aw/safe-outputs-content.md.
Summary
The daily AWF spec-compiler surfacing review found that several user-facing AWF schema capabilities merged in the last 7 days are not surfaced in the documentation. The root cause is that the auto-generated frontmatter reference is stale, plus a couple of features lack any hand-written coverage.
This is the first run of the surfacing reviewer (no prior state), so the diff window was built from the GitHub API over the last 7 days.
New schema features detected (last 7 days)
observability.otlp.resource-attributessafe-outputs.*.normalize-closing-keywords(create-issue / add-comment / create-pull-request)format-jsonrepo-memory.md; missing from generated referencereport-failure-as-issuefailure-category filteringrequired-categoryruns-on-slim,safe-outputs.runs-on, detectionruns-on)allowed-reposmax-ai-creditsCore finding: generated frontmatter reference is stale
docs/src/content/docs/reference/frontmatter-full.mdis auto-generated from the JSON Schema (make generate-schema-docs→node scripts/generate-schema-docs.js), but it is out of sync with the current schema. It documents everyobservability.otlpkey except the newly addedresource-attributes, and is also missingnormalize-closing-keywordsandformat-json.Evidence
properties/observability/properties/otlp/properties/resource-attributesinpkg/parser/schemas/main_workflow_schema.json.69e4c042(Support array/object runner specs forruns-on-slimand safe-outputs runner fields #39654, 2026-06-16); the generator header states: "This documentation is automatically generated from the JSON Schema."frontmatter-full.md:resource-attributes,normalize-closing-keywords,format-jsonrequired-category,runs-on-slim,allowed-repos,max-ai-creditsresource-attributes:pkg/workflow/observability_otlp.go,pkg/workflow/compiler_orchestrator_workflow.go,pkg/workflow/frontmatter_types.go.Follow-up tasks
1. Regenerate the schema-derived frontmatter reference — Priority: HIGH
Run
make generate-schema-docsand commit the refresheddocs/src/content/docs/reference/frontmatter-full.md. This mechanically picks upresource-attributes,normalize-closing-keywords, andformat-json. Consider a CI check that fails when the generated doc drifts from the schema, to prevent recurrence.2. Document
observability.otlp.resource-attributesin hand-written docs — Priority: HIGHFeature (#39636): additional
OTEL_RESOURCE_ATTRIBUTESentries appended to the standard gh-aw/GitHub resource attributes; values may be static strings or GitHub Actions expressions; must not usesecrets.*/vars.*(exported to external tracing backends, not treated as secret). Add coverage to the observability section of.github/aw/syntax-agentic.md(already documents OTLP) and the relevant hand-written observability/audit reference, including the no-secrets safety note.3. Document
normalize-closing-keywordsin canonical safe-outputs docs — Priority: MEDIUMFeature (#39643): when true, strips backticks from recognized issue-closing keywords (e.g.
`Closes #1`→Closes #1) in body fields. Applies tocreate-issue,add-comment, andcreate-pull-request. Currently only referenced indocs/.../experimental/safe-outputs-samples.md. Add it to the canonical safe-outputs reference and the agent-facing.github/aw/safe-outputs-content.md.4. Verify
format-jsonsurvives regeneration — Priority: LOWrepo-memory
format-json(#39540) is documented inrepo-memory.mdbut absent from the generated reference; confirm task 1 restores it.Notes
model_multipliers.jsonremoval Remove legacymodel_multipliers.jsonartifacts and file-based multiplier merge path #38642, "effective tokens"→"AI Credits" rename Replace "effective tokens" with "AI Credits" in user-facing text #38481).awf-feature-surfacing/progress.json).