Surface recent AWF schema features in canonical docs and regenerate frontmatter reference#39956
Merged
pelikhan merged 2 commits intoJun 18, 2026
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Surface recent AWF schema features in documentation
Surface recent AWF schema features in canonical docs and regenerate frontmatter reference
Jun 18, 2026
pelikhan
approved these changes
Jun 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates gh-aw’s canonical documentation to surface recently added AWF frontmatter schema features (notably OTLP resource-attributes and safe-outputs normalize-closing-keywords) and refreshes the generated “full frontmatter” reference from the current schema.
Changes:
- Documented
observability.otlp.resource-attributesacross frontmatter and OpenTelemetry guide/reference pages, including a warning not to usesecrets.*/vars.*. - Documented
safe-outputs.*.normalize-closing-keywordswith examples for issue/comment/PR body handling. - Regenerated
frontmatter-full.mdfrom the schema to include newly shipped fields and updated descriptions.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/safe-outputs.md | Adds normalize-closing-keywords to examples and a dedicated explanation section. |
| docs/src/content/docs/reference/safe-outputs-pull-requests.md | Documents normalize-closing-keywords for PR creation and adds a short behavioral note. |
| docs/src/content/docs/reference/open-telemetry.mdx | Adds reference text for observability.otlp.resource-attributes and its secrecy constraints. |
| docs/src/content/docs/reference/frontmatter.md | Updates OTLP frontmatter description to include resource-attributes and the secrecy warning. |
| docs/src/content/docs/reference/frontmatter-full.md | Regenerated full schema reference; includes new fields and updated descriptions. |
| docs/src/content/docs/guides/open-telemetry.mdx | Adds a “Custom resource attributes” section with an example and secrecy warning. |
| .github/aw/syntax-agentic.md | Surfaces resource-attributes in agentic syntax documentation with the secrecy warning. |
| .github/aw/safe-outputs-content.md | Surfaces normalize-closing-keywords in safe-outputs content reference examples. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 8/8 changed files
- Comments generated: 3
Comment on lines
4934
to
4937
| # Maximum allowed size for git patches in kilobytes (KB) for create-pull-request | ||
| # only. Overrides safe-outputs max-patch-size for this output type. Defaults to | ||
| # 4096 KB (4 MB) when unset. | ||
| # 1024 KB (1 MB) when unset. | ||
| # (optional) |
Comment on lines
6986
to
6990
| # Maximum allowed size for git patches in kilobytes (KB) for | ||
| # push-to-pull-request-branch only. Overrides safe-outputs max-patch-size for this | ||
| # output type. Defaults to 4096 KB (4 MB) when unset. | ||
| # output type. Defaults to 1024 KB (1 MB) when unset. | ||
| # (optional) | ||
| max-patch-size: 1 |
Comment on lines
+8180
to
8183
| # Maximum allowed size for git patches in kilobytes (KB). Defaults to 1024 KB (1 | ||
| # MB). If patch exceeds this size, the job will fail. | ||
| # (optional) | ||
| max-patch-size: 1 |
This was referenced Jun 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Recent AWF schema additions landed without corresponding doc surfacing: the generated frontmatter reference was stale, and key hand-written docs did not cover new OTLP and safe-output fields. This updates generated and canonical docs so newly shipped schema capabilities are discoverable in the expected references.
Frontmatter schema reference refresh
docs/src/content/docs/reference/frontmatter-full.mdfrom current schema.observability.otlp.resource-attributessafe-outputs.*.normalize-closing-keywords(create-issue,add-comment,create-pull-request)repo-memory.format-jsonObservability docs:
resource-attributessurfaceddocs/src/content/docs/reference/frontmatter.mddocs/src/content/docs/guides/open-telemetry.mdxdocs/src/content/docs/reference/open-telemetry.mdx.github/aw/syntax-agentic.mdresource-attributesare exported externally and must not usesecrets.*/vars.*.Safe-outputs docs:
normalize-closing-keywordssurfaceddocs/src/content/docs/reference/safe-outputs.mddocs/src/content/docs/reference/safe-outputs-pull-requests.md.github/aw/safe-outputs-content.md