Skip to content

Commit be16441

Browse files
docs: update --image-tag documentation for digest-aware format (#2095)
Document the new digest-pinning format for --image-tag introduced in commit 52969fc. Updates the quick-reference table entry and the detailed section in cli-reference.md to describe the extended format: <tag>,squid=sha256:...,agent=sha256:...,agent-act=sha256:...,api-proxy=sha256:...,cli-proxy=sha256:... Also updates the predownload subcommand table to mention all supported image keys and link to the main --image-tag section. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 52969fc commit be16441

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs-site/src/content/docs/reference/cli-reference.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ awf [options] -- <command>
3333
| `--work-dir <dir>` | string | `/tmp/awf-<timestamp>` | Working directory for temporary files |
3434
| `--build-local` | flag | `false` | Build containers locally instead of pulling from registry |
3535
| `--image-registry <url>` | string | `ghcr.io/github/gh-aw-firewall` | Container image registry |
36-
| `--image-tag <tag>` | string | `latest` | Container image tag |
36+
| `--image-tag <tag>` | string | `latest` | Container image tag. Supports optional per-image digest pinning: `<tag>,squid=sha256:...,agent=sha256:...,agent-act=sha256:...,api-proxy=sha256:...,cli-proxy=sha256:...` |
3737
| `--skip-pull` | flag | `false` | Use local images without pulling from registry |
3838
| `-e, --env <KEY=VALUE>` | string | `[]` | Environment variable (repeatable) |
3939
| `--env-all` | flag | `false` | Pass all host environment variables |
@@ -333,7 +333,17 @@ Custom container image registry URL.
333333

334334
### `--image-tag <tag>`
335335

336-
Container image tag to use.
336+
Container image tag to use. Supports an optional digest-aware format for cryptographic image pinning:
337+
338+
```
339+
<tag>,squid=sha256:...,agent=sha256:...,agent-act=sha256:...,api-proxy=sha256:...,cli-proxy=sha256:...
340+
```
341+
342+
Digest keys correspond to each runtime container image. When a digest is provided, the image reference is pinned to `<registry>/<image>:<tag>@<digest>`, preventing tag mutation attacks. The setup action's `image-tag` output produces this format automatically when `pull-images: true` is set.
343+
344+
Which agent image key is used depends on the `--agent-image` preset:
345+
- `default` → `agent`
346+
- `act` → `agent-act`
337347

338348
### `--skip-pull`
339349

@@ -950,7 +960,7 @@ awf predownload [options]
950960
| Option | Type | Default | Description |
951961
|--------|------|---------|-------------|
952962
| `--image-registry <registry>` | string | `ghcr.io/github/gh-aw-firewall` | Container image registry |
953-
| `--image-tag <tag>` | string | `latest` | Container image tag (applies to squid, agent, and api-proxy images) |
963+
| `--image-tag <tag>` | string | `latest` | Container image tag (applies to squid, agent, agent-act, api-proxy, and cli-proxy images). Supports optional digest metadata — see [`--image-tag`](#--image-tag-tag) for format details. |
954964
| `--agent-image <value>` | string | `default` | Agent image preset (`default`, `act`) or custom image |
955965
| `--enable-api-proxy` | flag | `false` | Also download the API proxy image |
956966

0 commit comments

Comments
 (0)