Skip to content

[docs] Update glossary - daily scan#20493

Merged
pelikhan merged 1 commit intomainfrom
docs/glossary-2026-03-11-daily-3ebde2082c84e896
Mar 11, 2026
Merged

[docs] Update glossary - daily scan#20493
pelikhan merged 1 commit intomainfrom
docs/glossary-2026-03-11-daily-3ebde2082c84e896

Conversation

@github-actions
Copy link
Contributor

Glossary Updates - 2026-03-11

Scan Type

  • Incremental (daily - last 24 hours)
  • Full scan (weekly - last 7 days)

Terms Added

  • Inline Engine Definition: New engine configuration format using runtime: and provider: fields, added as part of Phase 1–4 PRs introducing EngineDefinition, EngineCatalog, inline engine schemas, AuthDefinition, and RequestShape
  • GITHUB_AW: System-injected runtime env var set to "true" in every gh-aw engine step
  • GH_AW_PHASE: System-injected env var identifying the execution phase ("agent" or "detection")
  • GH_AW_VERSION: System-injected env var with the gh-aw compiler version

Terms Updated

None.

Changes Analyzed

Related Changes

  • 726232aa: docs(environment-variables): document system-injected GITHUB_AW, GH_AW_PHASE, GH_AW_VERSION
  • 32b3a711: Add GITHUB_AW, GH_AW_PHASE, and GH_AW_VERSION env vars to engine execution steps
  • a185bcfe: Phase 1: Introduce EngineDefinition, EngineCatalog, ResolvedEngineTarget
  • 44cb3694: Phase 2: Make EngineCatalog the single source of truth for engine metadata
  • 95f4259a: Phase 3: Extend schema and parser for inline and catalog-defined engine definitions
  • 9f0be697: Phase 4: Add AuthDefinition and RequestShape for provider-owned auth and request shaping

Generated by Glossary Maintainer ·

  • expires on Mar 13, 2026, 10:21 AM UTC

Add 4 new terms identified from recent commits:
- Inline Engine Definition (Phase 3-4: runtime+provider inline engine config)
- GITHUB_AW (system-injected runtime env var)
- GH_AW_PHASE (system-injected execution phase env var)
- GH_AW_VERSION (system-injected compiler version env var)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot added documentation Improvements or additions to documentation glossary labels Mar 11, 2026
@pelikhan pelikhan marked this pull request as ready for review March 11, 2026 11:37
Copilot AI review requested due to automatic review settings March 11, 2026 11:37
@pelikhan pelikhan merged commit e6da8d3 into main Mar 11, 2026
@pelikhan pelikhan deleted the docs/glossary-2026-03-11-daily-3ebde2082c84e896 branch March 11, 2026 11:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds new glossary entries to document inline AI engine configuration and system-injected environment variables for GitHub Agentic Workflows.

Changes:

  • Adds a glossary definition and example for “Inline Engine Definition”.
  • Documents GITHUB_AW, GH_AW_PHASE, and GH_AW_VERSION as system-injected environment variables.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +213 to +230
An engine configuration format that specifies a runtime adapter and optional provider settings directly in workflow frontmatter, without requiring a named catalog entry. Uses a `runtime` object (with `id` and optional `version`) to identify the adapter and an optional `provider` object for model selection, authentication, and request shaping. Useful for connecting to self-hosted or third-party AI backends.

```aw wrap
engine:
runtime:
id: codex
provider:
id: azure-openai
model: gpt-4o
auth:
strategy: oauth-client-credentials
token-url: https://auth.example.com/oauth/token
client-id: AZURE_CLIENT_ID
client-secret: AZURE_CLIENT_SECRET
request:
path-template: /openai/deployments/{model}/chat/completions
query:
api-version: "2024-10-01-preview"
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

The “Inline Engine Definition” section introduces an engine.runtime + engine.provider schema (with fields like token-url, path-template, etc.), but the documented/typed frontmatter schema elsewhere in this repo defines engine as either a string (engine: codex) or an object with fields like id, version, model, env, etc. (see docs/src/content/docs/reference/frontmatter-full.md around the engine: definition). As written, this glossary entry conflicts with the existing reference docs and may mislead users into using unsupported keys. Please either (a) update the glossary example/definition to match the current supported engine schema, or (b) if this is a new feature, add/update the corresponding reference docs and schema so this format is consistently documented.

Suggested change
An engine configuration format that specifies a runtime adapter and optional provider settings directly in workflow frontmatter, without requiring a named catalog entry. Uses a `runtime` object (with `id` and optional `version`) to identify the adapter and an optional `provider` object for model selection, authentication, and request shaping. Useful for connecting to self-hosted or third-party AI backends.
```aw wrap
engine:
runtime:
id: codex
provider:
id: azure-openai
model: gpt-4o
auth:
strategy: oauth-client-credentials
token-url: https://auth.example.com/oauth/token
client-id: AZURE_CLIENT_ID
client-secret: AZURE_CLIENT_SECRET
request:
path-template: /openai/deployments/{model}/chat/completions
query:
api-version: "2024-10-01-preview"
An engine configuration format that specifies the engine directly in workflow frontmatter, without requiring a named catalog entry. Uses the same schema as the `engine` field in frontmatter: either a string (for a named engine) or an object with fields like `id`, `version`, `model`, and optional `env` for environment-specific configuration (for example, API keys or endpoints).
```aw wrap
engine:
id: codex
version: "1"
model: gpt-4o
env:
AZURE_OPENAI_ENDPOINT: https://my-endpoint.openai.azure.com
AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation glossary

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants