docs: fix documentation drift — missing create-pull-request config options#495
Merged
jamesadevine merged 2 commits intoMay 11, 2026
Merged
Conversation
Add missing config options to the create-pull-request section in docs/safe-outputs.md. The following fields existed in CreatePrConfig but were not documented: - title-prefix: prefix prepended to all PR titles - if-no-changes: behavior when patch is empty (warn/error/ignore) - max-files: maximum files in a single PR (default: 100) - protected-files: file protection policy (blocked/allowed) - excluded-files: glob patterns for files to exclude from patch - allowed-labels: allowlist of labels the agent may apply - fallback-record-branch: record branch info on PR creation failure Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
@copilot resolve the merge conflicts in this pull request |
…nfig-options-b51fc700be55b8ac # Conflicts: # docs/safe-outputs.md Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Contributor
Resolved. I merged No UI changes were made in this PR, so there is no UI screenshot to provide. 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:
|
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 compared the source code against all documentation files (
AGENTS.md,docs/*.md,README.md,prompts/create-ado-agentic-workflow.md).Findings
create-pull-requestconfig section missing 7 options present inCreatePrConfigstructdocs/safe-outputs.mdDetails
The
CreatePrConfigstruct insrc/safeoutputs/create_pr.rsdefines these fields that were not documented in thedocs/safe-outputs.mdconfiguration options section:title-prefixOption<String>if-no-changes"warn"warn,error,ignoremax-filesusize100protected-files"blocked"blockedorallowedexcluded-filesVec<String>[]allowed-labelsVec<String>[]fallback-record-branchbooltrueAll other areas checked were accurate:
src/filesinit,compile,check,mcp,mcp-http,execute,configure) matchsrc/main.rsbase.yml/1es-base.ymlare documented indocs/template-markers.mdsrc/safeoutputs/are documentedclaude-opus-4.7), network domains, and schedule syntax are all accurateprompts/create-ado-agentic-workflow.mdis accurate for the fields it documentsApplied Fixes
title-prefix,if-no-changes,max-files,protected-files,excluded-files,allowed-labels, andfallback-record-branchto thecreate-pull-requestconfiguration options indocs/safe-outputs.mdThis pull request was created by the automated documentation freshness check.