Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions docs/src/content/docs/extensions/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Badge } from '@astrojs/starlight/components';

<Badge text="Beta" variant="caution" />

The [`ambient-action`](https://github.com/ambient-code/ambient-action) GitHub Action (v0.0.2) creates Ambient Code Platform sessions directly from GitHub workflows. Use it to automate bug fixes on new issues, run code analysis on pull requests, or trigger any agent workflow from CI/CD.
The [`ambient-action`](https://github.com/ambient-code/ambient-action) GitHub Action creates Ambient Code Platform sessions directly from GitHub workflows. Use it to automate bug fixes on new issues, run code analysis on pull requests, or trigger any agent workflow from CI/CD.

## Modes

Expand All @@ -18,26 +18,30 @@ The [`ambient-action`](https://github.com/ambient-code/ambient-action) GitHub Ac
| Input | Required | Default | Description |
|-------|----------|---------|-------------|
| `api-url` | Yes | -- | Ambient Code Platform API URL |
| `api-token` | Yes | -- | Bearer token for authentication (store as a GitHub secret) |
| `project` | Yes | -- | Target workspace/project name |
| `prompt` | Yes | -- | Task prompt for the agent |
| `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"}`) |
| `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 |
| `model` | No | -- | Model override (e.g., `claude-sonnet-4-20250514`) |
| `wait` | No | `false` | Wait for session completion |
| `timeout` | No | `30` | Session timeout in minutes |
| `poll-interval` | No | `15` | Seconds between status checks (only when `wait: true`) |
| `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`) |

Expand All @@ -55,7 +59,7 @@ jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: ambient-code/ambient-action@v0.0.2
- uses: ambient-code/ambient-action@v2
with:
api-url: ${{ secrets.ACP_URL }}
api-token: ${{ secrets.ACP_TOKEN }}
Expand All @@ -71,7 +75,7 @@ jobs:
Set `wait: true` to block the workflow until the session finishes:

```yaml
- uses: ambient-code/ambient-action@v0.0.2
- uses: ambient-code/ambient-action@v2
with:
api-url: ${{ secrets.ACP_URL }}
api-token: ${{ secrets.ACP_TOKEN }}
Expand All @@ -86,7 +90,7 @@ Set `wait: true` to block the workflow until the session finishes:
Pass a JSON array to clone multiple repositories into the session:

```yaml
- uses: ambient-code/ambient-action@v0.0.2
- uses: ambient-code/ambient-action@v2
id: session
with:
api-url: ${{ secrets.ACP_URL }}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/workflows/bugfix.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ jobs:
if: github.event.label.name == 'auto-fix'
runs-on: ubuntu-latest
steps:
- uses: ambient-code/ambient-action@v0.0.2
- uses: ambient-code/ambient-action@v2
with:
api-url: ${{ secrets.ACP_URL }}
api-token: ${{ secrets.ACP_TOKEN }}
Expand Down