Skip to content

Commit 8fb3432

Browse files
committed
docs: rename to Docker Agent Action and sync README with action.yml
- Rename title to 'Docker Agent Action' and update repo references to docker/docker-agent-action - Add missing inputs (skip-summary, org-membership-token, auth-org, skip-auth) - Add missing outputs (cagent-version, security-blocked, input-risk-level) - Fix prompt-suspicious description (content is stripped, not just detected) - Fix broken links: point Security Policy to .github/SECURITY.md, remove disabled Discussions link
1 parent d1c06a8 commit 8fb3432

1 file changed

Lines changed: 27 additions & 21 deletions

File tree

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cagent GitHub Action
1+
# Docker Agent Action
22

33
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 Docker Agent, handling binary downloads and environment configuration automatically.
44

@@ -7,7 +7,7 @@ A GitHub Action for running [Docker Agent](https://github.com/docker/docker-agen
77
1. **Add the action to your workflow**:
88

99
```yaml
10-
- uses: docker/cagent-action@VERSION
10+
- uses: docker/docker-agent-action@VERSION
1111
with:
1212
agent: path/to/agent.yaml
1313
prompt: "Analyze this code"
@@ -32,15 +32,15 @@ This action includes **built-in security features for all agent executions**:
3232
- **Prompt Injection Detection**: Warns about suspicious patterns in user prompts
3333
- **Automatic Incident Response**: Creates security issues and fails workflows when secrets are detected
3434

35-
See [security/README.md](security/README.md) for complete security documentation.
35+
To report a vulnerability, see our [Security Policy](.github/SECURITY.md).
3636

3737
## Usage
3838

3939
### Using a Local Agent File
4040

4141
```yaml
4242
- name: Run Custom Agent
43-
uses: docker/cagent-action@VERSION
43+
uses: docker/docker-agent-action@VERSION
4444
with:
4545
agent: ./agents/my-agent.yaml
4646
prompt: "Analyze the codebase"
@@ -51,7 +51,7 @@ See [security/README.md](security/README.md) for complete security documentation
5151

5252
```yaml
5353
- name: Run Docker Agent with Custom Settings
54-
uses: docker/cagent-action@VERSION
54+
uses: docker/docker-agent-action@VERSION
5555
with:
5656
agent: docker/code-analyzer
5757
prompt: "Analyze this codebase"
@@ -71,7 +71,7 @@ See [security/README.md](security/README.md) for complete security documentation
7171
```yaml
7272
- name: Run Docker Agent
7373
id: agent
74-
uses: docker/cagent-action@VERSION
74+
uses: docker/docker-agent-action@VERSION
7575
with:
7676
agent: docker/code-analyzer
7777
prompt: "Analyze this codebase"
@@ -116,6 +116,10 @@ See [security/README.md](security/README.md) for complete security documentation
116116
| `retry-delay` | Base delay in seconds between retries (doubles each attempt) | No | `5` |
117117
| `extra-args` | Additional arguments to pass to `docker agent run` | No | - |
118118
| `add-prompt-files` | Comma-separated list of files to append to the prompt (e.g., `AGENTS.md,CLAUDE.md`) | No | - |
119+
| `skip-summary` | Skip writing agent output to the job summary (useful when callers write their own) | No | `false` |
120+
| `org-membership-token` | PAT with `read:org` scope for org membership authorization checks | No | - |
121+
| `auth-org` | GitHub organization to check membership against (used with `org-membership-token`) | No | - |
122+
| `skip-auth` | Skip the built-in authorization check (when the caller already performed its own) | No | `false` |
119123

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

@@ -140,15 +144,18 @@ add-prompt-files: "STYLE_GUIDE.md" # Found via hierarchy search
140144

141145
## Outputs
142146

143-
| Output | Description |
144-
| ----------------------- | -------------------------------------------------------- |
145-
| `exit-code` | Exit code from docker agent run |
146-
| `output-file` | Path to the output log file |
147-
| `mcp-gateway-installed` | Whether mcp-gateway was installed (`true`/`false`) |
148-
| `execution-time` | Agent execution time in seconds |
149-
| `verbose-log-file` | Path to the full verbose agent log (includes tool calls) |
150-
| `secrets-detected` | Whether secrets were detected in output |
151-
| `prompt-suspicious` | Whether suspicious patterns were detected in user prompt |
147+
| Output | Description |
148+
| ----------------------- | ---------------------------------------------------------------- |
149+
| `exit-code` | Exit code from docker agent run |
150+
| `output-file` | Path to the output log file |
151+
| `cagent-version` | Version of Docker Agent that was used |
152+
| `mcp-gateway-installed` | Whether mcp-gateway was installed (`true`/`false`) |
153+
| `execution-time` | Agent execution time in seconds |
154+
| `verbose-log-file` | Path to the full verbose agent log (includes tool calls) |
155+
| `security-blocked` | Whether execution was blocked due to security concerns (`true`/`false`) |
156+
| `secrets-detected` | Whether secrets were detected in output |
157+
| `prompt-suspicious` | Whether suspicious content was stripped from the prompt (`true`/`false`) |
158+
| `input-risk-level` | Risk level of input (`low`/`medium`/`high`) |
152159

153160
## API Keys
154161

@@ -198,14 +205,14 @@ jobs:
198205
- uses: actions/checkout@v4
199206
200207
- name: Security Review
201-
uses: docker/cagent-action@VERSION
208+
uses: docker/docker-agent-action@VERSION
202209
with:
203210
agent: docker/github-action-security-scanner
204211
prompt: "Analyze for security issues"
205212
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
206213
207214
- name: Code Quality Analysis
208-
uses: docker/cagent-action@VERSION
215+
uses: docker/docker-agent-action@VERSION
209216
with:
210217
agent: docker/code-quality-analyzer
211218
prompt: "Analyze code quality and best practices"
@@ -238,7 +245,7 @@ jobs:
238245
- uses: actions/checkout@v4
239246
240247
- name: Run Agent
241-
uses: docker/cagent-action@VERSION
248+
uses: docker/docker-agent-action@VERSION
242249
with:
243250
agent: ${{ github.event.inputs.agent }}
244251
prompt: ${{ github.event.inputs.prompt }}
@@ -259,9 +266,8 @@ Please also read our [Code of Conduct](CODE_OF_CONDUCT.md).
259266
## Support
260267

261268
- 📖 [Documentation](README.md)
262-
- 🐛 [Report Issues](https://github.com/docker/cagent-action/issues)
263-
- 💬 [Discussions](https://github.com/docker/cagent-action/discussions)
264-
- 🔒 [Security Policy](security/README.md)
269+
- 🐛 [Report Issues](https://github.com/docker/docker-agent-action/issues)
270+
- 🔒 [Security Policy](.github/SECURITY.md)
265271

266272
## License
267273

0 commit comments

Comments
 (0)