Conversation
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>
There was a problem hiding this comment.
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, andGH_AW_VERSIONas 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.
| 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" |
There was a problem hiding this comment.
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.
| 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 }} |
Glossary Updates - 2026-03-11
Scan Type
Terms Added
runtime:andprovider:fields, added as part of Phase 1–4 PRs introducingEngineDefinition,EngineCatalog, inline engine schemas,AuthDefinition, andRequestShapeGITHUB_AW: System-injected runtime env var set to"true"in every gh-aw engine stepGH_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 versionTerms Updated
None.
Changes Analyzed
726232aa)safe-outputs.environmentfield doc (commitb29e1969) — no new glossary term needed (covered by existing "Environment Variables (env)" entry)failure-issue-repofeature (commit5af0feea) — already in glossaryRelated Changes
726232aa: docs(environment-variables): document system-injected GITHUB_AW, GH_AW_PHASE, GH_AW_VERSION32b3a711: Add GITHUB_AW, GH_AW_PHASE, and GH_AW_VERSION env vars to engine execution stepsa185bcfe: Phase 1: Introduce EngineDefinition, EngineCatalog, ResolvedEngineTarget44cb3694: Phase 2: Make EngineCatalog the single source of truth for engine metadata95f4259a: Phase 3: Extend schema and parser for inline and catalog-defined engine definitions9f0be697: Phase 4: Add AuthDefinition and RequestShape for provider-owned auth and request shaping