Skip to content

Commit b061379

Browse files
update github action docs to match ambient-action v2
the docs were pinned to v0.0.2 and missing several inputs/outputs that have been added since. syncs the inputs table (adds session-name, stop-on-run-finished, poll-timeout), outputs table (adds session-url), fixes the timeout description, and bumps all examples to @v2. closes #1232 Signed-off-by: Vishali <vsanghis@redhat.com>
1 parent cec7993 commit b061379

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

docs/src/content/docs/extensions/github-action.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,30 @@ The [`ambient-action`](https://github.com/ambient-code/ambient-action) GitHub Ac
1818

1919
| Input | Required | Default | Description |
2020
|-------|----------|---------|-------------|
21-
| `api-url` | Yes | -- | Ambient Code Platform backend API URL |
22-
| `api-token` | Yes | -- | Bot user bearer token for authentication (store as a GitHub secret) |
23-
| `project` | Yes | -- | Target workspace/project name |
21+
| `api-url` | Yes | -- | Ambient Code Platform API URL |
22+
| `api-token` | Yes | -- | Bot user bearer token (store as a GitHub secret) |
23+
| `project` | Yes | -- | Ambient project/namespace name |
2424
| `prompt` | Yes | -- | Initial prompt for the session, or message to send to an existing session |
2525
| `session-name` | No | -- | Existing session name to send a message to (skips session creation) |
2626
| `display-name` | No | -- | Human-readable session display name |
2727
| `repos` | No | -- | JSON array of repo objects (`[{"url":"...","branch":"...","autoPush":true}]`) |
2828
| `labels` | No | -- | JSON object of labels for the session |
2929
| `environment-variables` | No | -- | JSON object of environment variables to inject into the runner |
30-
| `workflow` | No | -- | JSON workflow object (e.g., `{"gitUrl":"https://...","branch":"main","path":"workflows/my-wf"}`) |
31-
| `model` | No | -- | Model override (e.g., `claude-sonnet-4-20250514`) |
32-
| `timeout` | No | `0` | Session inactivity timeout in seconds -- auto-stops after this duration of inactivity (`0` means no timeout) |
30+
| `timeout` | No | `0` | Session inactivity timeout in seconds (auto-stops after this duration of inactivity; `0` means no timeout) |
3331
| `stop-on-run-finished` | No | `false` | Stop the session automatically when the agent finishes its run |
34-
| `wait` | No | `false` | Wait for session completion |
35-
| `poll-interval` | No | `15` | Seconds between status checks (only when `wait: true`) |
36-
| `poll-timeout` | No | `60` | Maximum minutes to poll before giving up (only when `wait: true`) |
32+
| `model` | No | -- | Model override (e.g., `claude-sonnet-4-20250514`) |
33+
| `workflow` | No | -- | JSON workflow object (e.g., `{"gitUrl":"https://...","branch":"main","path":"workflows/my-wf"}`) |
34+
| `wait` | No | `false` | Wait for session completion before exiting |
35+
| `poll-interval` | No | `15` | Seconds between status polls (only when `wait: true`) |
36+
| `poll-timeout` | No | `60` | Max minutes to poll before giving up (only when `wait: true`) |
3737
| `no-verify-ssl` | No | `false` | Disable SSL certificate verification (for self-signed certs) |
3838

3939
## Outputs
4040

4141
| Output | Description |
4242
|--------|-------------|
43-
| `session-name` | Name of the created session |
44-
| `session-uid` | UID of the created session |
43+
| `session-name` | Created session name |
44+
| `session-uid` | Created session UID |
4545
| `session-url` | URL to the session in the Ambient UI |
4646
| `session-phase` | Final session phase (only set when `wait: true`) |
4747
| `session-result` | Session result text (only set when `wait: true`) |
@@ -60,7 +60,7 @@ jobs:
6060
triage:
6161
runs-on: ubuntu-latest
6262
steps:
63-
- uses: ambient-code/ambient-action@v0.0.5
63+
- uses: ambient-code/ambient-action@v2
6464
with:
6565
api-url: ${{ secrets.ACP_URL }}
6666
api-token: ${{ secrets.ACP_TOKEN }}
@@ -76,7 +76,7 @@ jobs:
7676
Set `wait: true` to block the workflow until the session finishes:
7777

7878
```yaml
79-
- uses: ambient-code/ambient-action@v0.0.5
79+
- uses: ambient-code/ambient-action@v2
8080
with:
8181
api-url: ${{ secrets.ACP_URL }}
8282
api-token: ${{ secrets.ACP_TOKEN }}
@@ -91,7 +91,7 @@ Set `wait: true` to block the workflow until the session finishes:
9191
Use `session-name` to send a follow-up prompt to a running session instead of creating a new one:
9292

9393
```yaml
94-
- uses: ambient-code/ambient-action@v0.0.5
94+
- uses: ambient-code/ambient-action@v2
9595
with:
9696
api-url: ${{ secrets.ACP_URL }}
9797
api-token: ${{ secrets.ACP_TOKEN }}
@@ -105,7 +105,7 @@ Use `session-name` to send a follow-up prompt to a running session instead of cr
105105
Pass a JSON array to clone multiple repositories into the session:
106106

107107
```yaml
108-
- uses: ambient-code/ambient-action@v0.0.5
108+
- uses: ambient-code/ambient-action@v2
109109
id: session
110110
with:
111111
api-url: ${{ secrets.ACP_URL }}

docs/src/content/docs/workflows/bugfix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ jobs:
348348
if: github.event.label.name == 'auto-fix'
349349
runs-on: ubuntu-latest
350350
steps:
351-
- uses: ambient-code/ambient-action@v0.0.5
351+
- uses: ambient-code/ambient-action@v2
352352
with:
353353
api-url: ${{ secrets.ACP_URL }}
354354
api-token: ${{ secrets.ACP_TOKEN }}

0 commit comments

Comments
 (0)