Skip to content

Surface recent AWF schema features in canonical docs and regenerate frontmatter reference#39956

Merged
pelikhan merged 2 commits into
mainfrom
copilot/awf-feature-surfacing-surface-recent-schema-featur
Jun 18, 2026
Merged

Surface recent AWF schema features in canonical docs and regenerate frontmatter reference#39956
pelikhan merged 2 commits into
mainfrom
copilot/awf-feature-surfacing-surface-recent-schema-featur

Conversation

Copilot AI commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

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

    • Regenerated docs/src/content/docs/reference/frontmatter-full.md from current schema.
    • Brought newly merged fields into generated output, including:
      • observability.otlp.resource-attributes
      • safe-outputs.*.normalize-closing-keywords (create-issue, add-comment, create-pull-request)
      • repo-memory.format-json
  • Observability docs: resource-attributes surfaced

    • Added explicit coverage in:
      • docs/src/content/docs/reference/frontmatter.md
      • docs/src/content/docs/guides/open-telemetry.mdx
      • docs/src/content/docs/reference/open-telemetry.mdx
      • .github/aw/syntax-agentic.md
    • Included safety note that resource-attributes are exported externally and must not use secrets.* / vars.*.
  • Safe-outputs docs: normalize-closing-keywords surfaced

    • Added canonical documentation and examples in:
      • docs/src/content/docs/reference/safe-outputs.md
      • docs/src/content/docs/reference/safe-outputs-pull-requests.md
      • .github/aw/safe-outputs-content.md
    • Clarified behavior for backtick-wrapped closing keywords in body fields.
observability:
  otlp:
    resource-attributes:
      service.namespace: platform-automation
      deployment.environment: ${{ github.ref_name }}

safe-outputs:
  create-issue:
    normalize-closing-keywords: true
  add-comment:
    normalize-closing-keywords: true
  create-pull-request:
    normalize-closing-keywords: true

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
Copilot AI requested a review from pelikhan June 18, 2026 06:00
@pelikhan pelikhan marked this pull request as ready for review June 18, 2026 06:03
Copilot AI review requested due to automatic review settings June 18, 2026 06:03
@pelikhan pelikhan merged commit cad9224 into main Jun 18, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/awf-feature-surfacing-surface-recent-schema-featur branch June 18, 2026 06:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-attributes across frontmatter and OpenTelemetry guide/reference pages, including a warning not to use secrets.* / vars.*.
  • Documented safe-outputs.*.normalize-closing-keywords with examples for issue/comment/PR body handling.
  • Regenerated frontmatter-full.md from 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants