docs: fix documentation drift — missing create-pull-request and add-pr-comment config fields#489
Merged
Conversation
…fields Several configuration fields present in CreatePrConfig were missing from docs/safe-outputs.md and prompts/create-ado-agentic-workflow.md: - title-prefix: optional prefix prepended to PR titles - if-no-changes: behavior when patch is empty (warn/error/ignore) - max-files: maximum files per PR patch (default: 100) - protected-files: policy for pipeline/CI file modifications (blocked/allowed) - excluded-files: glob patterns to exclude from the patch - allowed-labels: allowlist of labels the agent can apply - fallback-record-branch: record branch in failure data (default: true) Also document missing add-pr-comment agent parameters (line, start_line, status) and the allowed-statuses config field. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
@copilot resolve the merge conflicts in this pull request |
Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Contributor
Resolved and pushed in commit 8a10d86. I merged latest Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
jamesadevine
approved these changes
May 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
create-pull-requestconfigCreatePrConfigstruct missing from docsdocs/safe-outputs.md,prompts/create-ado-agentic-workflow.mdadd-pr-commentagent paramsline,start_line,status) missing from docsdocs/safe-outputs.mdadd-pr-commentconfigallowed-statusesconfig field missing from docsdocs/safe-outputs.mdDetails
create-pull-requestmissing config options (src/safeoutputs/create_pr.rsCreatePrConfigstruct):The following fields are accepted in front matter but not documented anywhere:
title-prefix""if-no-changes"warn"warn,error, orignoremax-files100protected-files"blocked"blocked/allowed)excluded-files[]allowed-labels[]fallback-record-branchtrueadd-pr-commentmissing items (src/safeoutputs/add_pr_comment.rs):line,start_line, andstatuswere missing — these enable inline comments with line ranges and custom thread status valuesallowed-statuses(restricts which status values the agent can set) was not documentedApplied Fixes
create-pull-requestconfig fields todocs/safe-outputs.mdcreate-pull-requestconfig options to the example inprompts/create-ado-agentic-workflow.mdStep 9line,start_line,statusagent params toadd-pr-commentindocs/safe-outputs.mdallowed-statusesconfig field toadd-pr-commentindocs/safe-outputs.mdThis pull request was created by the automated documentation freshness check.