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: docs/safe-outputs.md
+4-20Lines changed: 4 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,7 @@ output:
26
26
labels: [automation, agent] # Optional: labels to attach to issues
27
27
```
28
28
29
-
**How Your Agent Provides Output:**
30
-
31
-
Your agentic workflow writes its content to `${{ env.GITHUB_AW_OUTPUT }}`. The output should be structured as:
29
+
The agentic part of your workflow should write its content to `${{ env.GITHUB_AW_OUTPUT }}`. The output should be structured as:
32
30
- **First non-empty line**: Becomes the issue title (markdown heading syntax like `# Title` is automatically stripped)
33
31
- **Remaining content**: Becomes the issue body
34
32
@@ -55,9 +53,7 @@ output:
55
53
issue_comment: {} # Create comments on issues/PRs from workflow output
56
54
```
57
55
58
-
**How Your Agent Provides Output:**
59
-
60
-
Your agentic workflow writes its content to `${{ env.GITHUB_AW_OUTPUT }}`. The entire content becomes the comment body—no special formatting is required.
56
+
The agentic part of your workflow should writes its content to `${{ env.GITHUB_AW_OUTPUT }}`. The entire content becomes the comment body—no special formatting is required.
61
57
62
58
**Example natural language to generate the output:**
63
59
@@ -86,9 +82,7 @@ output:
86
82
draft: true # Optional: create as draft PR (defaults to true)
87
83
```
88
84
89
-
**How Your Agent Provides Output:**
90
-
91
-
Your agentic workflow provides output in two ways:
85
+
The agentic part of your workflow should provide output in two ways:
92
86
1. **File changes**: Make any file changes in the working directory—these are automatically collected using `git add -A` and committed
93
87
2. **PR description**: Write to `${{ env.GITHUB_AW_OUTPUT }}` with:
94
88
- **First non-empty line**: Becomes the PR title
@@ -105,14 +99,6 @@ Analyze the latest commit and suggest improvements.
105
99
2. Write a PR title and description to ${{ env.GITHUB_AW_OUTPUT }}
106
100
```
107
101
108
-
**Which Files are Included in Pull Request**
109
-
110
-
The agentic part of your workflow simply makes file changes, and the system:
111
-
1. Stages changes with `git add -A`
112
-
2. Commits them as "[agent] staged files"
113
-
3. Generates git patches using `git format-patch`
114
-
4. Creates a pull request with these changes
115
-
116
102
### Label Addition (`labels:`)
117
103
118
104
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.
@@ -126,9 +112,7 @@ output:
126
112
max-count: 3 # Optional: maximum number of labels to add (default: 3)
127
113
```
128
114
129
-
**How Your Agent Provides Output:**
130
-
131
-
Your agentic workflow writes labels to add to `${{ env.GITHUB_AW_OUTPUT }}`, one label per line:
115
+
The agentic part of your workflow writes should labels to add to `${{ env.GITHUB_AW_OUTPUT }}`, one label per line:
0 commit comments