Skip to content

Commit 602e300

Browse files
committed
fix lint
1 parent ecfcd3a commit 602e300

1 file changed

Lines changed: 5 additions & 15 deletions

File tree

‎docs/safe-outputs.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,9 @@ The `output:` element of your workflow's frontmatter declares that your agentic
1212
3. The compiler automatically generates additional jobs that read this output and perform the requested actions
1313
4. Only these generated jobs receive the necessary write permissions
1414

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
1616

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:`)
2818

2919
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.
3020

@@ -60,7 +50,7 @@ The first line of your output will become the issue title.
6050
The rest will become the issue body.
6151
```
6252

63-
## Issue Comment Creation (`issue_comment:`)
53+
### Issue Comment Creation (`issue_comment:`)
6454

6555
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.
6656

@@ -93,7 +83,7 @@ Your entire output will be posted as a comment on the triggering issue or PR.
9383

9484
This automatically creates GitHub issues or comments from the agent's analysis without requiring write permissions on the main job.
9585

96-
## Pull Request Creation (`pull-request:`)
86+
### Pull Request Creation (`pull-request:`)
9787

9888
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.
9989

@@ -159,7 +149,7 @@ The workflow automatically handles patch creation—your agent simply makes file
159149
3. Generates git patches using `git format-patch`
160150
4. Validates patch existence and content before proceeding with PR creation
161151

162-
## Label Addition (`labels:`)
152+
### Label Addition (`labels:`)
163153

164154
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.
165155

0 commit comments

Comments
 (0)