You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-21Lines changed: 27 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# cagent GitHub Action
1
+
# Docker Agent Action
2
2
3
3
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.
4
4
@@ -7,7 +7,7 @@ A GitHub Action for running [Docker Agent](https://github.com/docker/docker-agen
7
7
1.**Add the action to your workflow**:
8
8
9
9
```yaml
10
-
- uses: docker/cagent-action@VERSION
10
+
- uses: docker/docker-agent-action@VERSION
11
11
with:
12
12
agent: path/to/agent.yaml
13
13
prompt: "Analyze this code"
@@ -32,15 +32,15 @@ This action includes **built-in security features for all agent executions**:
32
32
- **Prompt Injection Detection**: Warns about suspicious patterns in user prompts
33
33
- **Automatic Incident Response**: Creates security issues and fails workflows when secrets are detected
34
34
35
-
See [security/README.md](security/README.md) for complete security documentation.
35
+
To report a vulnerability, see our [Security Policy](.github/SECURITY.md).
36
36
37
37
## Usage
38
38
39
39
### Using a Local Agent File
40
40
41
41
```yaml
42
42
- name: Run Custom Agent
43
-
uses: docker/cagent-action@VERSION
43
+
uses: docker/docker-agent-action@VERSION
44
44
with:
45
45
agent: ./agents/my-agent.yaml
46
46
prompt: "Analyze the codebase"
@@ -51,7 +51,7 @@ See [security/README.md](security/README.md) for complete security documentation
51
51
52
52
```yaml
53
53
- name: Run Docker Agent with Custom Settings
54
-
uses: docker/cagent-action@VERSION
54
+
uses: docker/docker-agent-action@VERSION
55
55
with:
56
56
agent: docker/code-analyzer
57
57
prompt: "Analyze this codebase"
@@ -71,7 +71,7 @@ See [security/README.md](security/README.md) for complete security documentation
71
71
```yaml
72
72
- name: Run Docker Agent
73
73
id: agent
74
-
uses: docker/cagent-action@VERSION
74
+
uses: docker/docker-agent-action@VERSION
75
75
with:
76
76
agent: docker/code-analyzer
77
77
prompt: "Analyze this codebase"
@@ -116,6 +116,10 @@ See [security/README.md](security/README.md) for complete security documentation
116
116
| `retry-delay` | Base delay in seconds between retries (doubles each attempt) | No | `5` |
117
117
| `extra-args` | Additional arguments to pass to `docker agent run` | No | - |
118
118
| `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` |
119
123
120
124
### Prompt Files (`add-prompt-files`)
121
125
@@ -140,15 +144,18 @@ add-prompt-files: "STYLE_GUIDE.md" # Found via hierarchy search
0 commit comments