Skip to content

Commit 2b415fa

Browse files
committed
fix docs
1 parent 84e4101 commit 2b415fa

1 file changed

Lines changed: 4 additions & 20 deletions

File tree

docs/safe-outputs.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ output:
2626
labels: [automation, agent] # Optional: labels to attach to issues
2727
```
2828
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:
3230
- **First non-empty line**: Becomes the issue title (markdown heading syntax like `# Title` is automatically stripped)
3331
- **Remaining content**: Becomes the issue body
3432

@@ -55,9 +53,7 @@ output:
5553
issue_comment: {} # Create comments on issues/PRs from workflow output
5654
```
5755

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.
6157

6258
**Example natural language to generate the output:**
6359

@@ -86,9 +82,7 @@ output:
8682
draft: true # Optional: create as draft PR (defaults to true)
8783
```
8884

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:
9286
1. **File changes**: Make any file changes in the working directory—these are automatically collected using `git add -A` and committed
9387
2. **PR description**: Write to `${{ env.GITHUB_AW_OUTPUT }}` with:
9488
- **First non-empty line**: Becomes the PR title
@@ -105,14 +99,6 @@ Analyze the latest commit and suggest improvements.
10599
2. Write a PR title and description to ${{ env.GITHUB_AW_OUTPUT }}
106100
```
107101

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-
116102
### Label Addition (`labels:`)
117103

118104
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:
126112
max-count: 3 # Optional: maximum number of labels to add (default: 3)
127113
```
128114

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:
132116
```
133117
triage
134118
bug

0 commit comments

Comments
 (0)