Skip to content

Update cagent repo URLs #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtardif merged 1 commit into from
Mar 9, 2026
Merged

Update cagent repo URLs #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ jobs:
fi
echo "Using cagent version from CAGENT_VERSION: ${CAGENT_VERSION}"
curl -fL -o cagent \
"https://github.com/docker/cagent/releases/download/${CAGENT_VERSION}/cagent-linux-amd64"
"https://github.com/docker/docker-agent/releases/download/${CAGENT_VERSION}/cagent-linux-amd64"
chmod +x cagent
sudo mv cagent /usr/local/bin/

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-cagent-version.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ jobs:
CURRENT: ${{ steps.check.outputs.current }}
run: |
BRANCH="auto/update-cagent-version"
RELEASE_URL="https://github.com/docker/cagent/releases/tag/$VERSION"
RELEASE_URL="https://github.com/docker/docker-agent/releases/tag/$VERSION"

# Configure git
git config user.name "github-actions[bot]"
Expand Down
72 changes: 36 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cagent GitHub Action

A GitHub Action for running [cagent](https://github.com/docker/cagent) AI agents in your workflows. This action simplifies the setup and execution of cagent, handling binary downloads and environment configuration automatically.
A GitHub Action for running [Docker Agent](https://github.com/docker/docker-agent) AI agents in your workflows. This action simplifies the setup and execution of cagent, handling binary downloads and environment configuration automatically.

## Quick Start

Expand All @@ -15,7 +15,6 @@ A GitHub Action for running [cagent](https://github.com/docker/cagent) AI agents
```

2. **Configure API key** in your repository settings:

- Go to `Settings` → `Secrets and variables` → `Actions`
- Add `ANTHROPIC_API_KEY` (or another provider's key) from [Anthropic Console](https://console.anthropic.com/)

Expand Down Expand Up @@ -51,11 +50,11 @@ For automated pull request reviews with a multi-agent system, see the [PR Review
```yaml
name: PR Review
on:
issue_comment: # Enables /review command in PR comments
issue_comment: # Enables /review command in PR comments
types: [created]
pull_request_review_comment: # Captures feedback on review comments for learning
types: [created]
pull_request_target: # Triggers auto-review on PR open; uses base branch context so secrets work with forks
pull_request_target: # Triggers auto-review on PR open; uses base branch context so secrets work with forks
types: [ready_for_review, opened]

permissions:
Expand All @@ -66,14 +65,14 @@ jobs:
uses: docker/cagent-action/.github/workflows/review-pr.yml@latest
# Scoped to the job so other jobs in this workflow aren't over-permissioned
permissions:
contents: read # Read repository files and PR diffs
contents: read # Read repository files and PR diffs
pull-requests: write # Post review comments and approve/request changes
issues: write # Create security incident issues if secrets are detected in output
checks: write # (Optional) Show review progress as a check run on the PR
issues: write # Create security incident issues if secrets are detected in output
checks: write # (Optional) Show review progress as a check run on the PR
secrets:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
CAGENT_ORG_MEMBERSHIP_TOKEN: ${{ secrets.CAGENT_ORG_MEMBERSHIP_TOKEN }} # PAT with read:org scope; gates auto-reviews to org members only
CAGENT_REVIEWER_APP_ID: ${{ secrets.CAGENT_REVIEWER_APP_ID }} # GitHub App ID; reviews appear as your app instead of github-actions[bot]
CAGENT_ORG_MEMBERSHIP_TOKEN: ${{ secrets.CAGENT_ORG_MEMBERSHIP_TOKEN }} # PAT with read:org scope; gates auto-reviews to org members only
CAGENT_REVIEWER_APP_ID: ${{ secrets.CAGENT_REVIEWER_APP_ID }} # GitHub App ID; reviews appear as your app instead of github-actions[bot]
CAGENT_REVIEWER_APP_PRIVATE_KEY: ${{ secrets.CAGENT_REVIEWER_APP_PRIVATE_KEY }} # GitHub App private key; paired with App ID above
```

Expand Down Expand Up @@ -137,30 +136,30 @@ See the [full PR Review documentation](review-pr/README.md) for more details.

## Inputs

| Input | Description | Required | Default |
| --------------------- | ------------------------------------------------------------------------------------ | -------- | ------------------------------- |
| `agent` | Agent identifier (e.g., `docker/code-analyzer`) or path to `.yaml` file | Yes | - |
| `prompt` | Prompt to pass to the agent | No | - |
| `mcp-gateway` | Install mcp-gateway (`true`/`false`) | No | `false` |
| `mcp-gateway-version` | Version of mcp-gateway to use (specifying this will enable mcp-gateway installation) | No | `v0.22.0` |
| `anthropic-api-key` | Anthropic API key for Claude models (at least one API key required) | No* | - |
| `openai-api-key` | OpenAI API key (at least one API key required) | No* | - |
| `google-api-key` | Google API key for Gemini models (at least one API key required) | No* | - |
| `aws-bearer-token-bedrock` | AWS Bearer token for Bedrock models (at least one API key required) | No* | - |
| `xai-api-key` | xAI API key for Grok models (at least one API key required) | No* | - |
| `nebius-api-key` | Nebius API key (at least one API key required) | No* | - |
| `mistral-api-key` | Mistral API key (at least one API key required) | No* | - |
| `github-token` | GitHub token for API access | No | `github.token` |
| `github-app-id` | GitHub App ID for custom identity (comments/reviews appear as the app) | No | - |
| `github-app-private-key` | GitHub App private key (required if `github-app-id` is provided) | No | - |
| `timeout` | Timeout in seconds for agent execution (0 for no timeout) | No | `0` |
| `debug` | Enable debug mode with verbose logging (`true`/`false`) | No | `false` |
| `working-directory` | Working directory to run the agent in | No | `.` |
| `yolo` | Auto-approve all prompts (`true`/`false`) | No | `true` |
| `max-retries` | Maximum number of retries on failure (0 = no retries) | No | `2` |
| `retry-delay` | Base delay in seconds between retries (doubles each attempt) | No | `5` |
| `extra-args` | Additional arguments to pass to `cagent run` | No | - |
| `add-prompt-files` | Comma-separated list of files to append to the prompt (e.g., `AGENTS.md,CLAUDE.md`) | No | - |
| Input | Description | Required | Default |
| -------------------------- | ------------------------------------------------------------------------------------ | -------- | -------------- |
| `agent` | Agent identifier (e.g., `docker/code-analyzer`) or path to `.yaml` file | Yes | - |
| `prompt` | Prompt to pass to the agent | No | - |
| `mcp-gateway` | Install mcp-gateway (`true`/`false`) | No | `false` |
| `mcp-gateway-version` | Version of mcp-gateway to use (specifying this will enable mcp-gateway installation) | No | `v0.22.0` |
| `anthropic-api-key` | Anthropic API key for Claude models (at least one API key required) | No\* | - |
| `openai-api-key` | OpenAI API key (at least one API key required) | No\* | - |
| `google-api-key` | Google API key for Gemini models (at least one API key required) | No\* | - |
| `aws-bearer-token-bedrock` | AWS Bearer token for Bedrock models (at least one API key required) | No\* | - |
| `xai-api-key` | xAI API key for Grok models (at least one API key required) | No\* | - |
| `nebius-api-key` | Nebius API key (at least one API key required) | No\* | - |
| `mistral-api-key` | Mistral API key (at least one API key required) | No\* | - |
| `github-token` | GitHub token for API access | No | `github.token` |
| `github-app-id` | GitHub App ID for custom identity (comments/reviews appear as the app) | No | - |
| `github-app-private-key` | GitHub App private key (required if `github-app-id` is provided) | No | - |
| `timeout` | Timeout in seconds for agent execution (0 for no timeout) | No | `0` |
| `debug` | Enable debug mode with verbose logging (`true`/`false`) | No | `false` |
| `working-directory` | Working directory to run the agent in | No | `.` |
| `yolo` | Auto-approve all prompts (`true`/`false`) | No | `true` |
| `max-retries` | Maximum number of retries on failure (0 = no retries) | No | `2` |
| `retry-delay` | Base delay in seconds between retries (doubles each attempt) | No | `5` |
| `extra-args` | Additional arguments to pass to `cagent run` | No | - |
| `add-prompt-files` | Comma-separated list of files to append to the prompt (e.g., `AGENTS.md,CLAUDE.md`) | No | - |

### Prompt Files (`add-prompt-files`)

Expand All @@ -169,6 +168,7 @@ The `add-prompt-files` input allows you to include additional context files as s
> **Note:** The `review-pr` action automatically reads `AGENTS.md` and `CLAUDE.md` from the repository root — you don't need to specify them via `add-prompt-files`. Use this input for additional files beyond those defaults.

**File Resolution (handled by cagent):**

- Searches up the directory hierarchy (like `.gitignore`)
- Also checks the home folder (`~/`)
- Files are added as system messages, not appended to the user prompt
Expand Down Expand Up @@ -201,6 +201,7 @@ add-prompt-files: "STYLE_GUIDE.md" # Found via hierarchy search
**At least one API key is required.** The action validates this at startup and fails fast with a clear error if no API key is provided.

Supported providers:

- **Anthropic** (`anthropic-api-key`): Claude models - [Get API key](https://console.anthropic.com/)
- **OpenAI** (`openai-api-key`): GPT models - [Get API key](https://platform.openai.com/)
- **Google** (`google-api-key`): Gemini models - [Get API key](https://aistudio.google.com/)
Expand All @@ -218,10 +219,9 @@ permissions:
contents: read
pull-requests: write
issues: write
checks: write # Optional: show review progress as a check run on PRs
checks: write # Optional: show review progress as a check run on PRs
```


## Examples

### Multiple Agents in a Workflow
Expand Down Expand Up @@ -314,5 +314,5 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS

## Links

- [cagent Repository](https://github.com/docker/cagent)
- [Docker Agent Repository](https://github.com/docker/docker-agent)
- [MCP Gateway Repository](https://github.com/docker/mcp-gateway)
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ runs:
if [[ "$CAGENT_CACHE_HIT" != "true" ]]; then
echo "Downloading cagent $CAGENT_VERSION for $PLATFORM-$ARCH_NAME..."
retry_download \
"https://github.com/docker/cagent/releases/download/$CAGENT_VERSION/$CAGENT_BINARY" \
"https://github.com/docker/docker-agent/releases/download/$CAGENT_VERSION/$CAGENT_BINARY" \
"$GITHUB_WORKSPACE/cagent"
chmod +x "$GITHUB_WORKSPACE/cagent"
else
Expand Down
2 changes: 1 addition & 1 deletion review-pr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The workflow automatically handles:

## Running Locally

Requires [cagent](https://github.com/docker/cagent) installed locally. The reviewer agent automatically detects its environment. When running locally, it diffs your current branch against the base branch and outputs findings to the console.
Requires [Docker Agent](https://github.com/docker/docker-agent) installed locally. The reviewer agent automatically detects its environment. When running locally, it diffs your current branch against the base branch and outputs findings to the console.

```bash
cd ~/code/my-project
Expand Down
3 changes: 1 addition & 2 deletions security/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This action includes **built-in security features for all agent executions**:
- Comment-triggered actions are the main abuse vector - this protects against cost/spam attacks

2. **Output Scanning** - All agent responses are scanned for leaked secrets:

- API key patterns: `sk-ant-*`, `sk-*`, `sk-proj-*`
- GitHub tokens: `ghp_*`, `gho_*`, `ghu_*`, `ghs_*`, `github_pat_*`
- Environment variable names in output
Expand Down Expand Up @@ -310,4 +309,4 @@ If you discover a security vulnerability, please:

- [OWASP Top 10](https://owasp.org/www-project-top-ten/)
- [GitHub Security Best Practices](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions)
- [cagent Repository](https://github.com/docker/cagent)
- [Docker Agent Repository](https://github.com/docker/docker-agent)
Loading