Skip to content

Commit e6da8d3

Browse files
docs: update glossary - daily scan 2026-03-11 (#20493)
1 parent c3a0db5 commit e6da8d3

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/src/content/docs/reference/glossary.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,30 @@ A time-based trigger format. Use short syntax like `daily` or `weekly on monday`
208208

209209
The AI system that powers the agentic workflow - essentially "which AI to use" to execute workflow instructions. GitHub Agentic Workflows supports multiple engines, with GitHub Copilot as the default.
210210

211+
### Inline Engine Definition
212+
213+
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.
214+
215+
```aw wrap
216+
engine:
217+
runtime:
218+
id: codex
219+
provider:
220+
id: azure-openai
221+
model: gpt-4o
222+
auth:
223+
strategy: oauth-client-credentials
224+
token-url: https://auth.example.com/oauth/token
225+
client-id: AZURE_CLIENT_ID
226+
client-secret: AZURE_CLIENT_SECRET
227+
request:
228+
path-template: /openai/deployments/{model}/chat/completions
229+
query:
230+
api-version: "2024-10-01-preview"
231+
```
232+
233+
See [Engines Reference](/gh-aw/reference/engines/).
234+
211235
### Fuzzy Scheduling
212236

213237
Natural language schedule syntax that automatically distributes workflow execution times to avoid load spikes. Instead of specifying exact times with cron expressions, fuzzy schedules like `daily`, `weekly`, or `daily on weekdays` are converted by the compiler into deterministic but scattered cron expressions. The compiler automatically adds `workflow_dispatch:` trigger for manual runs. Example: `schedule: daily on weekdays` compiles to something like `43 5 * * 1-5` with varied execution times across different workflows.
@@ -340,6 +364,18 @@ A category of features for automatically expiring workflow resources to reduce r
340364

341365
Configuration section in frontmatter defining environment variables for the workflow. Variables can reference GitHub context values, workflow inputs, or static values. Accessible via `${{ env.VARIABLE_NAME }}` syntax.
342366

367+
### `GITHUB_AW`
368+
369+
A system-injected environment variable set to `"true"` in every gh-aw engine execution step (both the agent run and the threat-detection run). Agents can check this variable to confirm they are running inside a GitHub Agentic Workflow. Cannot be overridden by user-defined `env:` blocks. See [Environment Variables Reference](/gh-aw/reference/environment-variables/).
370+
371+
### `GH_AW_PHASE`
372+
373+
A system-injected environment variable identifying the active execution phase. Set to `"agent"` during the main agent run and `"detection"` during the threat-detection safety check run that precedes it. Cannot be overridden by user-defined `env:` blocks. See [Environment Variables Reference](/gh-aw/reference/environment-variables/).
374+
375+
### `GH_AW_VERSION`
376+
377+
A system-injected environment variable containing the gh-aw compiler version that generated the workflow (e.g. `"0.40.1"`). Useful for writing conditional logic that depends on a minimum feature version. Cannot be overridden by user-defined `env:` blocks. See [Environment Variables Reference](/gh-aw/reference/environment-variables/).
378+
343379
### Repo Memory
344380

345381
Persistent file storage via Git branches with unlimited retention. Unlike cache-memory (7-day retention), repo-memory stores files permanently in dedicated Git branches with automatic branch cloning, file access, commits, pushes, and merge conflict resolution. Setting `wiki: true` switches the backing to the GitHub Wiki's git endpoint (`{repo}.wiki.git`), and the agent receives guidance to follow GitHub Wiki Markdown conventions (e.g. `[[Page Name]]` links). See [Repo Memory](/gh-aw/reference/repo-memory/).

0 commit comments

Comments
 (0)