Skip to content

docs: fix documentation drift — missing create-pull-request and add-pr-comment config fields #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesadevine merged 2 commits into from
May 11, 2026
+11 −0
Merged

docs: fix documentation drift — missing create-pull-request and add-pr-comment config fields #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e34f292
docs: document missing create-pull-request and add-pr-comment config …
github-actions[bot] May 9, 2026
8a10d86
Merge origin/main into docs branch and resolve docs conflict
Copilot May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/safe-outputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,13 +230,17 @@ Adds a new comment thread to a pull request.
- `content` - Comment text in markdown format (required, at least 10 characters)
- `repository` - Repository alias (default: "self")
- `file_path` *(optional)* - File path for an inline comment anchored to a specific file
- `line` *(optional)* - Line number for an inline comment. Requires `file_path`.
- `start_line` *(optional)* - Starting line for a multi-line inline comment range. Requires `file_path` and `line`, and must be strictly less than `line`.
- `status` *(optional)* - Initial thread status: `"active"` (default), `"fixed"`, `"wont-fix"`, `"closed"`, or `"by-design"`. Subject to the `allowed-statuses` allowlist.

**Configuration options (front matter):**
```yaml
safe-outputs:
add-pr-comment:
comment-prefix: "[Agent Review] " # Optional — prepended to all comments
allowed-repositories: [] # Optional — restrict which repos can be commented on
allowed-statuses: [] # Optional — restrict which thread statuses the agent can set (empty = any)
max: 1 # Maximum per run (default: 1)
include-stats: true # Append agent stats to comment (default: true)
```
Expand Down
7 changes: 7 additions & 0 deletions prompts/create-ado-agentic-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,13 @@ safe-outputs:
auto-complete: true
delete-source-branch: true
squash-merge: true
title-prefix: "[Bot] " # Optional — prepended to every PR title
if-no-changes: warn # "warn" (default), "error", or "ignore" when the patch is empty
max-files: 100 # Reject patches touching more than this many files (default: 100)
protected-files: blocked # "blocked" (default) prevents changes to pipeline/CI files; "allowed" permits all
excluded-files: # Glob patterns for files to exclude from the patch
- "*.lock"
allowed-labels: [] # Restrict which labels the agent can apply (empty = any)
reviewers:
- "lead@example.com"
labels:
Expand Down