Generated banner for Pr Reference
Generated logo for Pr Reference

Pr Reference

MicrosoftOfficialPublished by Microsoft

  • Skill
  • Tool integration
  • Software development
  • MIT
  • Low risk
  • Has scripts

From the author

Generates PR reference XML with commit history and unified diffs between branches, with extension and path filtering. Use when creating pull request descriptions, preparing code reviews, analyzing branch changes, discovering work items from diffs, or generating structured diff summaries.
— the description by Microsoft

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

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/microsoft/pr-reference/download
  2. Unzip 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.

PlatformRuntime
macOS / LinuxBash (pre-installed)
WindowsPowerShell 7+ (pwsh)
Cross-platformPowerShell 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,json
scripts/generate.ps1
scripts/generate.ps1 -BaseBranch auto -MergeBase -ExcludeExt yml,json

Output saves to .copilot-tracking/pr/pr-reference.xml by default.

Parameters Reference

ParameterFlag (bash)Flag (PowerShell)DefaultDescription
Base branch--base-branch-BaseBranchorigin/main (bash) / main (PowerShell)Target branch for comparison. Use auto to detect remote default.
Merge base--merge-base-MergeBasefalseUse git merge-base for three-way comparison
Exclude markdown--no-md-diff-ExcludeMarkdownDifffalseExclude 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.xmlCustom 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 table
scripts/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
ParameterFlag (bash)Flag (PowerShell)DefaultDescription
Input path--input, -i-InputPath(auto)Path to pr-reference.xml
Type filter--type, -t-TypeallChange 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-FormatplainOutput 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 summary
scripts/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 file

Output 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

SymptomCauseResolution
"No commits found" or empty XMLNo diverging commits from base branchVerify the branch has commits ahead of the base with git log base..HEAD
"Branch not found" errorBase branch ref missing locallyRun git fetch origin to update remote tracking refs
"git: command not found"git is not on PATHInstall git or verify PATH includes the git binary directory

Files

scripts/list-changed-files.ps1

# Copyright (c) 2026 Microsoft Corporation. All rights reserved.
# SPDX-License-Identifier: MIT
#Requires -Version 7.4

<#
.SYNOPSIS
Extracts and lists all changed files from a PR reference XML.

.DESCRIPTION
Parses the pr-reference.xml file to extract file paths from diff headers.
Supports filtering by change type and multiple output formats.

.PARAMETER InputPath
Path to the PR reference XML file. Defaults to .copilot-tracking/pr/pr-reference.xml.

.PARAMETER Type
Filter by change type. Accepts a single value or comma-separated values:
Added, Deleted, Modified, Renamed, or All. Defaults to All.

.PARAMETER ExcludeType
Exclude specific change types. Accepts a single value or comma-separated values:
Added, Deleted, Modified, or Renamed. Mutually exclusive with -Type when -Type is not All.

.PARAMETER Format
Output format: Plain, Json, or Markdown. Defaults to Plain.

.EXAMPLE
./list-changed-files.ps1
Lists all changed files in plain text format.

.EXAMPLE
./list-changed-files.ps1 -Type Added -Format Markdown
Lists only added files in markdown table format.

.EXAMPLE
./list-changed-files.ps1 -Type Added,Modified,Renamed
Lists added, modified, and renamed files.

.EXAMPLE
./list-changed-files.ps1 -ExcludeType Deleted
Lists all files except deleted ones.
#>

[CmdletBinding()]
param(
    [Parameter()]
    [Alias('i', 'Input')]
    [string]$InputPath = "",

    [Parameter()]
    [Alias('t')]
    [string[]]$Type = @('All'),

    [Parameter()]
    [string[]]$ExcludeType = @(),

    [Parameter()]
    [Alias('f')]
    [ValidateSet('Plain', 'Json', 'Markdown')]
    [string]$Format = "Plain"
)

$ErrorActionPreference = 'Stop'

Import-Module (Join-Path $PSScriptRoot 'shared.psm1') -Force

function Get-FileChanges {
    [OutputType([PSCustomObject[]])]
    param(
        [Parameter(Mandatory)]
        [string]$XmlPath,

        [Parameter()]
        [string[]]$FilterType = @('All'),

        [Parameter()]
        [string[]]$ExcludeFilterType = @()
    )

    # Normalize comma-separated strings into arrays
    $normalizedFilter = @()
    foreach ($ft in $FilterType) {
        $normalizedFilter += $ft -split ','
    }
    $normalizedExclude = @()
    foreach ($et in $ExcludeFilterType) {
        $normalizedExclude += $et -split ','
    }

    $validTypes = @('All', 'Added', 'Deleted', 'Modified', 'Renamed')
    foreach ($t in $normalizedFilter) {
        if ($t -and $t -notin $validTypes) {
            throw "Invalid type filter: '$t'. Valid values: $($validTypes -join ', ')"
        }
    }
    foreach ($t in $normalizedExclude) {
        if ($t -and $t -notin @('Added', 'Deleted', 'Modified', 'Renamed')) {
            throw "Invalid exclude type: '$t'. Valid values: Added, Deleted, Modified, Renamed"
        }
    }

    $content = Get-Content -LiteralPath $XmlPath -Raw
    $changes = @()

    # Pair the commit-section close with the diff opener so standalone opening tags in
    # hunk context cannot move the boundary. The final pair follows unescaped commit bodies;
    # generate.sh can append </commits> to the last commit line.
    $boundaries = [regex]::Matches($content, '(?m)</commits>[ \t]*\r?\n(?:[ \t]*\r?\n)*  <full_diff>[ \t]*\r?$')
    if ($boundaries.Count -gt 0) {
        $boundary = $boundaries[$boundaries.Count - 1]
        $content = $content.Substring($boundary.Index + $boundary.Length)
    } else {
        # References without commit metadata start at their first diff opener.
        $open = [regex]::Match($content, '(?m)^  <full_diff>[ \t]*\r?$')
        if ($open.Success) { $content = $content.Substring($open.Index + $open.Length) }
    }

    # Match diff headers and analyze change type. Headers start a line: at column 0
    # from generate.sh, or indented two spaces by generate.ps1. Anchoring there keeps
    # 'diff --git' text inside diff content from being read as a header.
    $indent = if ($content -cmatch '(?m)^diff --git ') { '' } else { '  ' }
    $diffPattern = "(?ms)^${indent}diff --git a/(.+?) b/(.+?)(?=\n)(.*?)(?=^${indent}diff --git|</full_diff>)"
    $regexMatches = [regex]::Matches($content, $diffPattern)

    foreach ($match in $regexMatches) {
        $oldPath = $match.Groups[1].Value.Trim()
        $newPath = $match.Groups[2].Value.Trim()
        $diffBlock = $match.Groups[3].Value

        # Mode lines are header lines at the same indent; hunk lines start with ' ', '+', '-' or '\'
        $changeType = 'Modified'
        if ($diffBlock -cmatch "(?m)^${indent}new file mode") {
            $changeType = 'Added'
        }
        elseif ($diffBlock -cmatch "(?m)^${indent}deleted file mode") {
            $changeType = 'Deleted'
        }
        elseif ($diffBlock -cmatch "(?m)^${indent}rename from" -or $oldPath -ne $newPath) {
            $changeType = 'Renamed'
        }

        # Apply exclusion filter
        if ($normalizedExclude.Count -gt 0 -and $changeType -in $normalizedExclude) {
            continue
        }

        # Apply inclusion filter
        if ('All' -notin $normalizedFilter -and $changeType -notin $normalizedFilter) {
            continue
        }

        $displayPath = if ($changeType -eq 'Renamed') {
            "$oldPath -> $newPath"
        } else {
            $newPath
        }

        $changes += [PSCustomObject]@{
            Path = $displayPath
            Type = $changeType
        }
    }

    return $changes | Sort-Object -Property Path
}

function Format-Output {
    [OutputType([string])]
    param(
        [Parameter(Mandatory)]
        [PSCustomObject[]]$Changes,

        [Parameter()]
        [string]$OutputFormat = "Plain"
    )

    switch ($OutputFormat) {
        'Plain' {
            return ($Changes | ForEach-Object { $_.Path }) -join [Environment]::NewLine
        }
        'Json' {
            return $Changes | ConvertTo-Json -Depth 2
        }
        'Markdown' {
            $lines = @(
                "| File | Change Type |",
                "|------|-------------|"
            )
            foreach ($change in $Changes) {
                $lines += "| ``$($change.Path)`` | $($change.Type) |"
            }
            return $lines -join [Environment]::NewLine
        }
    }
}

function Invoke-ListChangedFiles {
    [CmdletBinding()]
    [OutputType([string])]
    param(
        [Parameter()]
        [string]$InputPath = "",

        [Parameter()]
        [string[]]$Type = @('All'),

        [Parameter()]
        [string[]]$ExcludeType = @(),

        [Parameter()]
        [ValidateSet('Plain', 'Json', 'Markdown')]
        [string]$Format = "Plain"
    )

    # Validate mutual exclusion
    $hasNonAllType = ($Type | Where-Object { $_ -ne 'All' }).Count -gt 0
    if ($hasNonAllType -and $ExcludeType.Count -gt 0) {
        throw "-Type and -ExcludeType are mutually exclusive when -Type is not 'All'."
    }

    $repoRoot = Get-RepositoryRoot
    $xmlPath = if ($InputPath) {
        $InputPath
    } else {
        Join-Path $repoRoot '.copilot-tracking/pr/pr-reference.xml'
    }

    if (-not (Test-Path -LiteralPath $xmlPath)) {
        throw "PR reference file not found: $xmlPath`nRun generate.ps1 first to create the PR reference."
    }

    $changes = Get-FileChanges -XmlPath $xmlPath -FilterType $Type -ExcludeFilterType $ExcludeType
    $output = Format-Output -Changes $changes -OutputFormat $Format

    Write-Output $output
}

#region Main Execution
if ($MyInvocation.InvocationName -ne '.') {
    try {
        Invoke-ListChangedFiles -InputPath $InputPath -Type $Type -ExcludeType $ExcludeType -Format $Format
        exit 0
    }
    catch {
        Write-Error -ErrorAction Continue $_.Exception.Message
        exit 1
    }
}
#endregion

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