From b0613799109ac9767e7013ea97b5df8f637de403 Mon Sep 17 00:00:00 2001 From: Vishali Date: Tue, 7 Apr 2026 16:48:29 -0400 Subject: [PATCH] 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 --- .../content/docs/extensions/github-action.md | 30 +++++++++---------- docs/src/content/docs/workflows/bugfix.md | 2 +- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/src/content/docs/extensions/github-action.md b/docs/src/content/docs/extensions/github-action.md index 79e78377b..82217a1e3 100755 --- a/docs/src/content/docs/extensions/github-action.md +++ b/docs/src/content/docs/extensions/github-action.md @@ -18,30 +18,30 @@ The [`ambient-action`](https://github.com/ambient-code/ambient-action) GitHub Ac | Input | Required | Default | Description | |-------|----------|---------|-------------| -| `api-url` | Yes | -- | Ambient Code Platform backend API URL | -| `api-token` | Yes | -- | Bot user bearer token for authentication (store as a GitHub secret) | -| `project` | Yes | -- | Target workspace/project name | +| `api-url` | Yes | -- | Ambient Code Platform API URL | +| `api-token` | Yes | -- | Bot user bearer token (store as a GitHub secret) | +| `project` | Yes | -- | Ambient project/namespace name | | `prompt` | Yes | -- | Initial prompt for the session, or message to send to an existing session | | `session-name` | No | -- | Existing session name to send a message to (skips session creation) | | `display-name` | No | -- | Human-readable session display name | | `repos` | No | -- | JSON array of repo objects (`[{"url":"...","branch":"...","autoPush":true}]`) | | `labels` | No | -- | JSON object of labels for the session | | `environment-variables` | No | -- | JSON object of environment variables to inject into the runner | -| `workflow` | No | -- | JSON workflow object (e.g., `{"gitUrl":"https://...","branch":"main","path":"workflows/my-wf"}`) | -| `model` | No | -- | Model override (e.g., `claude-sonnet-4-20250514`) | -| `timeout` | No | `0` | Session inactivity timeout in seconds -- auto-stops after this duration of inactivity (`0` means no timeout) | +| `timeout` | No | `0` | Session inactivity timeout in seconds (auto-stops after this duration of inactivity; `0` means no timeout) | | `stop-on-run-finished` | No | `false` | Stop the session automatically when the agent finishes its run | -| `wait` | No | `false` | Wait for session completion | -| `poll-interval` | No | `15` | Seconds between status checks (only when `wait: true`) | -| `poll-timeout` | No | `60` | Maximum minutes to poll before giving up (only when `wait: true`) | +| `model` | No | -- | Model override (e.g., `claude-sonnet-4-20250514`) | +| `workflow` | No | -- | JSON workflow object (e.g., `{"gitUrl":"https://...","branch":"main","path":"workflows/my-wf"}`) | +| `wait` | No | `false` | Wait for session completion before exiting | +| `poll-interval` | No | `15` | Seconds between status polls (only when `wait: true`) | +| `poll-timeout` | No | `60` | Max minutes to poll before giving up (only when `wait: true`) | | `no-verify-ssl` | No | `false` | Disable SSL certificate verification (for self-signed certs) | ## Outputs | Output | Description | |--------|-------------| -| `session-name` | Name of the created session | -| `session-uid` | UID of the created session | +| `session-name` | Created session name | +| `session-uid` | Created session UID | | `session-url` | URL to the session in the Ambient UI | | `session-phase` | Final session phase (only set when `wait: true`) | | `session-result` | Session result text (only set when `wait: true`) | @@ -60,7 +60,7 @@ jobs: triage: runs-on: ubuntu-latest steps: - - uses: ambient-code/ambient-action@v0.0.5 + - uses: ambient-code/ambient-action@v2 with: api-url: ${{ secrets.ACP_URL }} api-token: ${{ secrets.ACP_TOKEN }} @@ -76,7 +76,7 @@ jobs: Set `wait: true` to block the workflow until the session finishes: ```yaml -- uses: ambient-code/ambient-action@v0.0.5 +- uses: ambient-code/ambient-action@v2 with: api-url: ${{ secrets.ACP_URL }} api-token: ${{ secrets.ACP_TOKEN }} @@ -91,7 +91,7 @@ Set `wait: true` to block the workflow until the session finishes: Use `session-name` to send a follow-up prompt to a running session instead of creating a new one: ```yaml -- uses: ambient-code/ambient-action@v0.0.5 +- uses: ambient-code/ambient-action@v2 with: api-url: ${{ secrets.ACP_URL }} 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 Pass a JSON array to clone multiple repositories into the session: ```yaml -- uses: ambient-code/ambient-action@v0.0.5 +- uses: ambient-code/ambient-action@v2 id: session with: api-url: ${{ secrets.ACP_URL }} diff --git a/docs/src/content/docs/workflows/bugfix.md b/docs/src/content/docs/workflows/bugfix.md index 45226baa1..cb3215f5d 100755 --- a/docs/src/content/docs/workflows/bugfix.md +++ b/docs/src/content/docs/workflows/bugfix.md @@ -348,7 +348,7 @@ jobs: if: github.event.label.name == 'auto-fix' runs-on: ubuntu-latest steps: - - uses: ambient-code/ambient-action@v0.0.5 + - uses: ambient-code/ambient-action@v2 with: api-url: ${{ secrets.ACP_URL }} api-token: ${{ secrets.ACP_TOKEN }}