Pr Reference
MicrosoftOfficialPublished by Microsoft
- Skill
- Tool integration
- Software development
- MIT
- Low risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The pr-reference skill provides a set of scripts to extract git commit metadata and diffs into a structured XML format. It supports cross-platform execution via Bash and PowerShell, allowing developers to generate comprehensive branch comparisons. Beyond generation, the skill includes utility scripts to list changed files and inspect specific diff chunks, making it a versatile tool for automating pull request descriptions, conducting code reviews, and performing security analysis on code changes.
What it does
- Generates an XML document containing commit history and unified diffs between branches.
- Supports filtering diffs by file extensions and directory paths to reduce noise.
- Provides utility scripts to list changed files with type-based filtering.
- Enables inspection of large diffs through chunked reading capabilities.
- Offers flexible base branch selection, including automatic remote default detection.
- Supports three-way comparison using git merge-base.
When to use it
- When you need to generate detailed pull request descriptions based on commit history.
- When preparing for code reviews and requiring structured context of changes.
- When you need to analyze branch changes or discover work items from diffs.
- When you need to perform security audits on modified files.
- When you need to exclude specific file types or paths from your diff analysis.
Advantages
- Structured XML output facilitates programmatic processing and integration.
- Cross-platform support ensures consistency across different development environments.
- Granular filtering options help focus on relevant code changes.
- Utility scripts simplify the extraction of specific file lists or diff segments.
- Supports standard git workflows like three-way merges.
Usage examples
- “Generate a PR reference comparing my current branch to the main branch.”
- The skill executes the generation script, creating an XML file at .copilot-tracking/pr/pr-reference.xml containing the commit history and diffs.
- “List all added and modified files from the generated PR reference.”
- The skill runs the list-changed-files script, outputting a filtered list of files based on the specified change types.
- “Read the diff for src/main.ts from the generated reference.”
- The skill extracts and displays the specific unified diff content for the requested file.
- “Generate a PR reference excluding all JSON and YAML files.”
- The skill generates the XML report while applying the specified extension filters to the diff output.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/microsoft/pr-reference/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip pr-reference.zip -d .agents/skills
Documentation by Microsoft
PR Reference Generation Skill
Overview
Queries git for commit metadata and diff output, then produces a structured XML document. Both bash and PowerShell implementations are provided.
Use cases:
PR description generation from commit history
Code review preparation with structured diff context
Work item discovery by analyzing branch changes
Security analysis of modified files
After successful generation, include a file link to the absolute path of the XML output in the response.
Prerequisites
The repository must have at least one commit diverging from the base branch.
| Platform | Runtime |
|---|---|
| macOS / Linux | Bash (pre-installed) |
| Windows | PowerShell 7+ (pwsh) |
| Cross-platform | PowerShell 7+ (pwsh) |
Quick Start
Run the following command to generate a PR reference with default settings (compares against origin/main):
scripts/generate.sh
scripts/generate.sh --base-branch auto --merge-base --exclude-ext yml,jsonscripts/generate.ps1
scripts/generate.ps1 -BaseBranch auto -MergeBase -ExcludeExt yml,jsonOutput saves to .copilot-tracking/pr/pr-reference.xml by default.
Parameters Reference
| Parameter | Flag (bash) | Flag (PowerShell) | Default | Description |
|---|---|---|---|---|
| Base branch | --base-branch | -BaseBranch | origin/main (bash) / main (PowerShell) | Target branch for comparison. Use auto to detect remote default. |
| Merge base | --merge-base | -MergeBase | false | Use git merge-base for three-way comparison |
| Exclude markdown | --no-md-diff | -ExcludeMarkdownDiff | false | Exclude markdown files (*.md) from the diff |
| Exclude extensions | --exclude-ext | -ExcludeExt | (none) | Comma-separated extensions to exclude (e.g., yml,yaml,json,png) |
| Exclude paths | --exclude-path | -ExcludePath | (none) | Comma-separated path prefixes to exclude (for example, documentation and GitHub configuration directories) |
| Output path | --output | -OutputPath | .copilot-tracking/pr/pr-reference.xml | Custom output file path |
Both defaults resolve to the same remote comparison. The PowerShell script automatically resolves origin/<branch> when a bare branch name is provided.
Additional Scripts Reference
After generating the PR reference, use these utility scripts to query the XML.
List Changed Files
Run the list script to extract file paths from the diff:
scripts/list-changed-files.sh # all changed files
scripts/list-changed-files.sh --type added # filter by single type
scripts/list-changed-files.sh --type added,modified,renamed # filter by multiple types
scripts/list-changed-files.sh --exclude-type deleted # exclude specific types
scripts/list-changed-files.sh --format markdown # output as markdown tablescripts/list-changed-files.ps1 # all changed files
scripts/list-changed-files.ps1 -Type Added # filter by single type
scripts/list-changed-files.ps1 -Type Added,Modified,Renamed # filter by multiple types
scripts/list-changed-files.ps1 -ExcludeType Deleted # exclude specific types
scripts/list-changed-files.ps1 -Format Json # output as JSON| Parameter | Flag (bash) | Flag (PowerShell) | Default | Description |
|---|---|---|---|---|
| Input path | --input, -i | -InputPath | (auto) | Path to pr-reference.xml |
| Type filter | --type, -t | -Type | all | Change types to include (comma-separated: added, modified, etc.) |
| Exclude type | --exclude-type | -ExcludeType | (none) | Change types to exclude. Mutually exclusive with --type (non-all) |
| Format | --format, -f | -Format | plain | Output format: plain, json, or markdown |
Read Diff Content
Run the read script to inspect diff content with chunking for large diffs:
scripts/read-diff.sh --info # chunk info (count, line ranges)
scripts/read-diff.sh --chunk 1 # read a specific chunk
scripts/read-diff.sh --file src/main.ts # extract diff for one file
scripts/read-diff.sh --summary # file stats summaryscripts/read-diff.ps1 -Info # chunk info
scripts/read-diff.ps1 -Chunk 1 # read a specific chunk
scripts/read-diff.ps1 -File "src/main.ts" # extract diff for one fileOutput Format
The generated XML wraps commit metadata and unified diff output in a <commit_history> root element. See the reference guide for the complete XML schema, element reference, output path variations, and workflow integration patterns.
Troubleshooting
| Symptom | Cause | Resolution |
|---|---|---|
| "No commits found" or empty XML | No diverging commits from base branch | Verify the branch has commits ahead of the base with git log base..HEAD |
| "Branch not found" error | Base branch ref missing locally | Run git fetch origin to update remote tracking refs |
| "git: command not found" | git is not on PATH | Install git or verify PATH includes the git binary directory |
Files
- ATTRIBUTION.mdAdded by AutoGineer827 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md7.0 KiB
- references/REFERENCE.md8.8 KiB
- scripts/generate.ps1Script15.4 KiB
- scripts/generate.shScript5.8 KiB
- scripts/list-changed-files.ps1Script7.5 KiB
- scripts/list-changed-files.shScript5.7 KiB
- scripts/read-diff.ps1Script8.2 KiB
- scripts/read-diff.shScript5.7 KiB
- scripts/shared.psm1Script2.5 KiB
- tests/generate.Tests.ps1Script19.7 KiB
- tests/list-changed-files.Tests.ps1Script27.1 KiB
- tests/read-diff.Tests.ps1Script18.6 KiB
- tests/shared.Tests.ps1Script5.7 KiB
references/REFERENCE.md
title: PR Reference Skill Reference description: XML output format, usage scenarios, output path variations, and semantic invocation patterns author: Microsoft ms.date: 2026-09-21 ms.topic: reference keywords:
pr-reference
xml
git estimated_reading_time: 5
XML Output Format
The PR reference generator produces an XML document with four top-level elements inside a <commit_history> root:
<commit_history>
<current_branch>
feature/add-authentication
</current_branch>
<base_branch>
origin/main
</base_branch>
<commits>
<commit hash="f3a21c7" date="2026-02-15">
<message>
<subject><![CDATA[feat: add JWT token validation]]></subject>
<body><![CDATA[Implements token validation middleware with
expiration checks and signature verification.]]></body>
</message>
</commit>
<commit hash="b8c94e2" date="2026-02-14">
<message>
<subject><![CDATA[chore: add auth dependency]]></subject>
<body><![CDATA[]]></body>
</message>
</commit>
</commits>
<full_diff>
diff --git a/src/middleware/auth.ts b/src/middleware/auth.ts
new file mode 100644
index 0000000..a1b2c3d
--- /dev/null
+++ b/src/middleware/auth.ts
@@ -0,0 +1,25 @@
+import { verify } from 'jsonwebtoken';
+
+export function validateToken(token: string): boolean {
+ // Token validation logic
+}
</full_diff>
</commit_history>Element Reference
| Element | Description |
|---|---|
<current_branch> | Active git branch name or detached@<sha> in CI environments |
<base_branch> | Comparison branch provided via --base-branch / -BaseBranch |
<commits> | Ordered commit entries with hash, date, subject, and body |
<full_diff> | Unified diff output from git diff |
Each <commit> element has hash and date attributes. The <subject> and <body> elements wrap content in CDATA sections to preserve special characters.
Usage Scenarios
Default PR Reference Generation
Generate a reference comparing the current branch against origin/main with output at the default location:
./scripts/generate.sh./scripts/generate.ps1Output: .copilot-tracking/pr/pr-reference.xml
Custom Base Branch Comparison
Compare against a branch other than origin/main, such as a release branch:
./scripts/generate.sh --base-branch origin/release/2.0./scripts/generate.ps1 -BaseBranch release/2.0The PowerShell script automatically resolves origin/release/2.0 when a bare branch name is provided.
Automatic Default Branch Detection
Detect the remote default branch instead of naming it, for repositories whose default is not main:
./scripts/generate.sh --base-branch auto./scripts/generate.ps1 -BaseBranch autoBoth scripts resolve auto from refs/remotes/origin/HEAD and fall back to origin/main when that symbolic ref is unset.
Merge-Base Three-Way Comparison
Compare against the common ancestor of the current branch and the base branch, so commits added to the base branch after you branched stay out of the diff:
./scripts/generate.sh --merge-base./scripts/generate.ps1 -MergeBaseMarkdown Exclusion for PR Descriptions
Exclude documentation changes from the diff when generating PR descriptions, reducing noise in the output:
./scripts/generate.sh --no-md-diff./scripts/generate.ps1 -ExcludeMarkdownDiffExtension and Path Exclusion
Exclude file extensions or path prefixes from the diff, for branches that carry generated or vendored changes alongside source edits:
./scripts/generate.sh --exclude-ext yml,yaml,json --exclude-path docs/,generated/./scripts/generate.ps1 -ExcludeExt yml,yaml,json -ExcludePath docs/,generated/Both flags take comma-separated values. A leading dot on an extension and a trailing slash on a path are stripped automatically.
Custom Output Path
Write the XML to a branch-specific tracking directory for PR review workflows:
./scripts/generate.sh \
--output .copilot-tracking/pr/review/feature-auth/pr-reference.xml./scripts/generate.ps1 `
-OutputPath .copilot-tracking/pr/review/feature-auth/pr-reference.xmlWork Item Discovery
Use a custom filename for work item discovery workflows that analyze branch changes:
./scripts/generate.sh \
--base-branch origin/main \
--output .copilot-tracking/workitems/discovery/sprint-42/git-branch-diff.xml./scripts/generate.ps1 `
-BaseBranch main `
-OutputPath .copilot-tracking/workitems/discovery/sprint-42/git-branch-diff.xmlOutput Path Variations
Different workflows use different output paths and filenames:
| Workflow | Output Filename | Output Path |
|---|---|---|
| Default PR generation | pr-reference.xml | .copilot-tracking/pr/pr-reference.xml |
| PR review | pr-reference.xml | .copilot-tracking/pr/review/{{branch}}/pr-reference.xml |
| New PR creation | pr-reference.xml | .copilot-tracking/pr/new/{{branch}}/pr-reference.xml |
| Work item discovery | git-branch-diff.xml | .copilot-tracking/workitems/discovery/{{folder}}/git-branch-diff.xml |
Utility Script Reference
list-changed-files
Extracts file paths from the PR reference XML diff headers.
| Parameter | Flag (bash) | Flag (PowerShell) | Default | Description |
|---|---|---|---|---|
| Input path | --input, -i | -InputPath | .copilot-tracking/pr/pr-reference.xml | Path to the PR reference XML |
| Change type | --type, -t | -Type | all | Filter: all, added, deleted, modified, renamed. Accepts comma-separated values |
| Exclude type | --exclude-type | -ExcludeType | (none) | Change types to exclude. Mutually exclusive with --type unless --type is all |
| Output format | --format, -f | -Format | plain | Output: plain, json, or markdown |
read-diff
Reads diff content with chunking and file filtering support.
| Parameter | Flag (bash) | Flag (PowerShell) | Default | Description |
|---|---|---|---|---|
| Input path | --input, -i | -InputPath | .copilot-tracking/pr/pr-reference.xml | Path to the PR reference XML |
| Chunk number | --chunk, -c | -Chunk | - | 1-based chunk number to read |
| Chunk size | --chunk-size, -s | -ChunkSize | 500 | Lines per chunk |
| Line range | --lines, -l | -Lines | - | Range format: START,END or START-END |
| File path | --file, -f | -File | - | Extract diff for specific file |
| Summary | --summary | -Summary | - | Show file list with change stats |
| Info | --info | -Info | - | Show chunk breakdown without content |
Semantic Invocation
Callers reference the skill by describing the task intent rather than hardcoding script paths. Copilot matches the task description against the skill's description and loads the skill on-demand.
<!-- Semantic invocation (preferred) -->
Generate the PR reference XML file comparing the current branch against origin/main.
<!-- Semantic invocation with parameters -->
Generate a PR reference XML excluding markdown diffs, saving to the review tracking directory.Avoid referencing script paths directly in prompts, agents, or instructions. The agent selects the appropriate script based on the current platform.
Requirements and compatibility
Written for: GitHub Copilot, Claude Code
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Claude Code frontmatter
The author says: Requires git available on PATH
Security
What our scanner noticed· Low risk
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/hve-core · .github/skills/shared/pr-reference · commit f425e94
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Microsoft.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download pr-reference.zip