Skip to content

Commit 47dc8f2

Browse files
docs: document JSON importer mapping, gemini-3.5-flash, footer-install default (#33522)
1 parent 8a1d710 commit 47dc8f2

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

docs/src/content/docs/reference/model-tables.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ Before per-model multipliers are applied, raw token counts are weighted by token
182182
| `gemini-3.1-flash-lite-preview` | 0.1 |
183183
| `gemini-3.1-flash-image-preview` | 0.33 |
184184
| `gemini-3.1-flash-tts-preview` | 0.1 |
185+
| `gemini-3.5-flash` | 14 |
185186
| `gemini-2.5-computer-use-preview` | 0.2 |
186187
| `gemini-2.5-computer-use-preview-10-2025` | 0.2 |
187188
| `gemini-robotics-er-1.5-preview` | 0.2 |

docs/src/content/docs/reference/safe-outputs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1603,6 +1603,8 @@ safe-outputs:
16031603

16041604
**Options**: `append-only-comments` (default: `false`)
16051605

1606+
The `footer-install` template renders the install instructions that follow the footer attribution line. When a workflow source is available and no custom template is set, the default renders as a collapsed `<details>` disclosure with the summary `Add this agentic workflows to your repo`; the expanded block contains the `gh aw add {workflow_source}` command. Custom `footer-install` overrides bypass the disclosure wrapper, so include `<details>` markup explicitly if you want the same collapsed UX. Supported placeholders: `{workflow_source}`, `{workflow_source_url}`.
1607+
16061608
**Variables**: `{workflow_name}`, `{run_url}`, `{agentic_workflow_url}`, `{triggering_number}`, `{workflow_source}`, `{workflow_source_url}`, `{event_type}`, `{status}`, `{operation}`, `{effective_tokens}`, `{effective_tokens_formatted}`, `{effective_tokens_suffix}`
16071609

16081610
`{effective_tokens}` contains the raw total effective token count for the run (e.g. `1200`), and `{effective_tokens_formatted}` is the compact human-readable form (e.g. `1.2K`, `3M`). Both are only present when the effective token count is greater than zero. `{effective_tokens_suffix}` is a pre-formatted, always-safe suffix string (e.g. `" · ● 1.2K"` or `""`) that can be inserted directly into footer templates alongside `{history_link}`. The default footer automatically includes the formatted value — use these variables in custom footer templates to include token usage in your own format. See [Effective Tokens Specification](/gh-aw/reference/effective-tokens-specification/) for details on how effective tokens are computed.

docs/src/content/docs/setup/cli.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,21 @@ Repository-level packages can declare an [`aw.yml` manifest](/gh-aw/reference/aw
176176

177177
`add` and `add-wizard` also accept arbitrary `http(s)://` URLs. The fetched response is dispatched by `Content-Type`: `text/markdown` (and `text/x-markdown`) is installed as a raw gh-aw workflow, and `application/json` (or any `*+json` suffix) is converted to a workflow markdown file before installation. Unknown content types produce an actionable error listing the detected type. For non-GitHub hosts, no include/dispatch-workflow dependency resolution is performed, and no GitHub authentication token is sent to the remote server.
178178

179+
##### JSON Workflow Field Mapping
180+
181+
When importing a JSON workflow definition (for example, a payload from the Copilot automation API), the importer translates JSON fields into gh-aw frontmatter and workflow body:
182+
183+
| JSON field | Mapped to | Notes |
184+
|------------|-----------|-------|
185+
| `triggers.interval` | `on:` (fuzzy schedule) | `hourly` → `every 1h`, `daily` → `daily`, `weekly` → `weekly`. A single interval trigger emits the inline shorthand (`on: daily`); the compiler randomizes cron at compile time. |
186+
| `triggers.issues` | `on.issues.types` | A `query` filter has no gh-aw equivalent and emits a per-field warning. |
187+
| `triggers.workflow_run` | `on.workflow_run` (`workflows`, `types`) | A `conclusions` filter emits a per-field warning. |
188+
| `tools` | `tools:` | A 40-entry lookup maps GitHub tool IDs to gh-aw toolsets (`issues`, `pull-requests`, `repos`, etc.). `execute` maps to `bash: "*"` (with a review warning); `web_search` maps to `web-search:`. Built-in read/edit/search tools are silently skipped. Unrecognized tools emit a per-tool warning. |
189+
| `permissions` | `permissions:` | Passed through unchanged. |
190+
| `prompt` | Workflow body | Used when an `instructions` field is absent. |
191+
192+
Unrecognized fields are preserved as commented hints in the generated workflow.
193+
179194
#### `new`
180195

181196
Create a workflow template in `.github/workflows/`. Opens for editing automatically.

0 commit comments

Comments
 (0)