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
{{ message }}
Repository navigation
Commit 602e300
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/safe-outputs.md
+5-15Lines changed: 5 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,19 +12,9 @@ The `output:` element of your workflow's frontmatter declares that your agentic
12
12
3. The compiler automatically generates additional jobs that read this output and perform the requested actions
13
13
4. Only these generated jobs receive the necessary write permissions
14
14
15
-
For example, if you want your agent to create a GitHub issue based on its analysis, you can add the following to your workflow frontmatter:
15
+
## Available Output Types
16
16
17
-
```yaml
18
-
output:
19
-
issue:
20
-
```
21
-
22
-
This declares that the workflow can create one new issue in the repository - and that's all.
23
-
This is done in a separate, non-agentic job that creates the issue after your main agentic job completes. This second job will implicitly have `issues: write` permissions, but your main job does not need `issues: write` permission, enhancing security.
24
-
25
-
### Available Output Types
26
-
27
-
## Issue Creation (`issue:`)
17
+
### New Issue Creation (`issue:`)
28
18
29
19
Adding `issue:` to the `output:` section of your workflow declares that the workflow should conclude with the creation of a GitHub issue based on the agent's output.
30
20
@@ -60,7 +50,7 @@ The first line of your output will become the issue title.
60
50
The rest will become the issue body.
61
51
```
62
52
63
-
## Issue Comment Creation (`issue_comment:`)
53
+
### Issue Comment Creation (`issue_comment:`)
64
54
65
55
Adding `issue_comment:` to the output section of your workflow declares that the workflow should conclude with posting a comment on the triggering issue or pull request based on the agent's output.
66
56
@@ -93,7 +83,7 @@ Your entire output will be posted as a comment on the triggering issue or PR.
93
83
94
84
This automatically creates GitHub issues or comments from the agent's analysis without requiring write permissions on the main job.
95
85
96
-
## Pull Request Creation (`pull-request:`)
86
+
### Pull Request Creation (`pull-request:`)
97
87
98
88
Adding `pull-request:` to the `output:` section of your workflow declares that the workflow should conclude with the creation of a pull request containing code changes generated by the agent.
99
89
@@ -159,7 +149,7 @@ The workflow automatically handles patch creation—your agent simply makes file
159
149
3. Generates git patches using `git format-patch`
160
150
4. Validates patch existence and content before proceeding with PR creation
161
151
162
-
## Label Addition (`labels:`)
152
+
### Label Addition (`labels:`)
163
153
164
154
Adding `labels:` to the `output:` section of your workflow declares that the workflow should conclude with adding labels to the current issue or pull request based on the agent's analysis.
0 commit comments