mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-24 04:00:02 +01:00
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request This update improves the release notes generation process by restructuring documentation for clarity and enhancing workflows. It introduces new tools for handling GitHub issue images and attachments, along with automated tests to ensure functionality. <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [ ] Closes: N/A - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [x] **Tests:** Added/updated and all pass - [ ] **Localization:** All end-user-facing strings can be localized - [x] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [x] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: N/A <!-- Provide a more detailed description of the PR, other things fixed, or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments The changes include updates to the release notes summarization process and workflow documentation for better clarity. New scripts for managing PR diffs, grouping, and milestone assignments have been added. Additionally, tools for downloading images and attachments from GitHub issues have been implemented, ensuring a more streamlined process. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed Automated tests were added for the new GitHub issue tools, and all tests passed successfully. Manual validation included testing the new workflows and ensuring the documentation accurately reflects the changes made. ```
101 lines
3.9 KiB
PowerShell
101 lines
3.9 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Produce an incremental PR CSV containing rows present in a newer full export but absent from a baseline export.
|
|
|
|
.DESCRIPTION
|
|
Compares two previously generated sorted PR CSV files (same schema). Any row whose key column value
|
|
(defaults to 'Number') does not exist in the baseline file is emitted to a new incremental CSV, preserving
|
|
the original column order. If no new rows are found, an empty CSV (with headers when determinable) is written.
|
|
|
|
.PARAMETER BaseCsv
|
|
Path to the baseline (earlier) PR CSV.
|
|
|
|
.PARAMETER AllCsv
|
|
Path to the newer full PR CSV containing superset (or equal set) of rows.
|
|
|
|
.PARAMETER OutCsv
|
|
Path to write the incremental CSV containing only new rows.
|
|
|
|
.PARAMETER Key
|
|
Column name used as unique identifier (defaults to 'Number'). Must exist in both CSVs.
|
|
|
|
.EXAMPLE
|
|
pwsh ./diff_prs.ps1 -BaseCsv sorted_prs_prev.csv -AllCsv sorted_prs.csv -OutCsv sorted_prs_incremental.csv
|
|
|
|
.NOTES
|
|
Requires: PowerShell 7+, both CSVs with identical column schemas.
|
|
Exit code 0 on success (even if zero incremental rows). Throws on missing files.
|
|
#>
|
|
|
|
[CmdletBinding()] param(
|
|
[Parameter(Mandatory=$false)][string]$BaseCsv = "./sorted_prs_93_round1.csv",
|
|
[Parameter(Mandatory=$false)][string]$AllCsv = "./sorted_prs.csv",
|
|
[Parameter(Mandatory=$false)][string]$OutCsv = "./sorted_prs_93_incremental.csv",
|
|
[Parameter(Mandatory=$false)][string]$Key = "Number"
|
|
)
|
|
|
|
Set-StrictMode -Version Latest
|
|
$ErrorActionPreference = 'Stop'
|
|
|
|
function Write-Info($m) { Write-Host "[info] $m" -ForegroundColor Cyan }
|
|
function Write-Warn($m) { Write-Host "[warn] $m" -ForegroundColor Yellow }
|
|
|
|
if (-not (Test-Path -LiteralPath $BaseCsv)) { throw "Base CSV not found: $BaseCsv" }
|
|
if (-not (Test-Path -LiteralPath $AllCsv)) { throw "All CSV not found: $AllCsv" }
|
|
|
|
# Load CSVs
|
|
$baseRows = Import-Csv -LiteralPath $BaseCsv
|
|
$allRows = Import-Csv -LiteralPath $AllCsv
|
|
|
|
if (-not $baseRows) { Write-Warn "Base CSV has no rows." }
|
|
if (-not $allRows) { Write-Warn "All CSV has no rows." }
|
|
|
|
# Validate key presence
|
|
if ($baseRows -and -not ($baseRows[0].PSObject.Properties.Name -contains $Key)) { throw "Key column '$Key' not found in base CSV." }
|
|
if ($allRows -and -not ($allRows[0].PSObject.Properties.Name -contains $Key)) { throw "Key column '$Key' not found in all CSV." }
|
|
|
|
# Build a set of existing keys from base
|
|
$set = New-Object 'System.Collections.Generic.HashSet[string]'
|
|
foreach ($row in $baseRows) {
|
|
$val = [string]($row.$Key)
|
|
if ($null -ne $val) { [void]$set.Add($val) }
|
|
}
|
|
|
|
# Filter rows in AllCsv whose key is not in base (these are the new / incremental rows)
|
|
$incremental = @()
|
|
foreach ($row in $allRows) {
|
|
$val = [string]($row.$Key)
|
|
if (-not $set.Contains($val)) { $incremental += $row }
|
|
}
|
|
|
|
# Preserve column order from the All CSV
|
|
$columns = @()
|
|
if ($allRows.Count -gt 0) {
|
|
$columns = $allRows[0].PSObject.Properties.Name
|
|
}
|
|
|
|
try {
|
|
if ($incremental.Count -gt 0) {
|
|
if ($columns.Count -gt 0) {
|
|
$incremental | Select-Object -Property $columns | Export-Csv -LiteralPath $OutCsv -NoTypeInformation -Encoding UTF8
|
|
} else {
|
|
$incremental | Export-Csv -LiteralPath $OutCsv -NoTypeInformation -Encoding UTF8
|
|
}
|
|
} else {
|
|
# Write an empty CSV with headers if we know them (facilitates downstream tooling expecting header row)
|
|
if ($columns.Count -gt 0) {
|
|
$obj = [PSCustomObject]@{}
|
|
foreach ($c in $columns) { $obj | Add-Member -NotePropertyName $c -NotePropertyValue $null }
|
|
$obj | Select-Object -Property $columns | Export-Csv -LiteralPath $OutCsv -NoTypeInformation -Encoding UTF8
|
|
} else {
|
|
'' | Out-File -LiteralPath $OutCsv -Encoding UTF8
|
|
}
|
|
}
|
|
Write-Info ("Incremental rows: {0}" -f $incremental.Count)
|
|
Write-Info ("Output: {0}" -f (Resolve-Path -LiteralPath $OutCsv))
|
|
}
|
|
catch {
|
|
Write-Host "[error] Failed writing output CSV: $_" -ForegroundColor Red
|
|
exit 1
|
|
}
|