Release Note Generation Skill
Generate professional PowerToys release notes by collecting merged PRs, summarizing each PR with the local CLI agent, grouping by label, and producing user-facing summaries. Stable and preview releases share the same PR metadata, attribution, grouping, and formatting rules.
Output Directory
All generated artifacts are placed under Generated Files/ReleaseNotes/ at the repository root (gitignored).
Generated Files/ReleaseNotes/
├── milestone_prs.json # Raw PR data from GitHub
├── sorted_prs.csv # Sorted PR list with Copilot summaries
├── prs_with_milestone.csv # Milestone assignment tracking
├── grouped_csv/ # PRs grouped by label (one CSV per label)
├── grouped_md/ # Generated markdown summaries per label
└── v{VERSION}-release-notes.md # Final consolidated release notes
Preview-release runs use an isolated subdirectory:
Generated Files/ReleaseNotes/preview-<buildId>/
├── release-context.json
├── delta-commits.json
├── delta-prs.json
├── removed-prs.json
├── unattributed-commits.json
├── MemberList.md
├── milestone_prs.json
├── sorted_prs.csv
├── release-notes.md
├── hashes.md
├── release-manifest.json # Local audit artifact; never uploaded
├── assets-manifest.json # Local asset inventory; never uploaded
└── final-review.md
When to Use This Skill
- Generate release notes for a milestone
- Summarize PRs merged in a release
- Generate per-PR review summaries locally for release-notes copy
- Assign milestones to PRs missing them
- Collect PRs between two commits/tags
- Update README.md for a new version
- Prepare GitHub release assets (download installers/symbols + compute hashes)
- Prepare a complete draft preview release from an ADO build URL or build ID
- Compare preview contents across
main and stable branch transitions
Prerequisites
- GitHub CLI (
gh) installed and authenticated — The collection script uses gh pr view and gh api graphql to fetch PR metadata and co-author information. Run gh auth status to verify; if not logged in, run gh auth login first. See Step 1.0.0 for details.
- MCP Server: github-mcp-server installed (used to fetch PR diffs/files for the local-agent review step)
- For preview releases and prepare-release-assets.ps1: Azure CLI authenticated against the Microsoft tenant (
az login) with the azure-devops extension; access to the microsoft/Dart ADO project
Required Variables
For a stable release, confirm {{ReleaseVersion}} with the user before starting.
For a preview release, do not request a version: derive it from the candidate ADO build.
| Variable |
Description |
Example |
{{ReleaseVersion}} |
Target release version |
0.98 |
Preview mode instead requires one ADO build URL or numeric build ID. It derives the version, source commit, branch, and previous release without asking the user.
Scenario routing
Read the scenario index, then follow only the selected scenario:
Workflow Overview
┌────────────────────────────────┐
│ 1.0 Verify gh auth + MemberList │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 1.1 Collect PRs (stable range) │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 1.2 Assign Milestones │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 2.1–2.4 Label PRs (auto+human) │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 3.1 Local-agent PR summaries │
│ (writes CopilotSummary) │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 3.2 (Optional) Refresh PR data │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 3.3 Group by label │
│ (grouped_csv) │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 4.1 Summarize (grouped_md) │
└────────────────────────────────┘
↓
┌────────────────────────────────┐
│ 4.2 Final notes (v{VERSION}.md) │
└────────────────────────────────┘
| Step |
Action |
Details |
| 1.0 |
Verify prerequisites |
gh auth status must pass; generate MemberList.md |
| 1.1 |
Collect PRs |
From previous release tag on stable branch → sorted_prs.csv |
| 1.2 |
Assign Milestones |
Ensure all PRs have correct milestone |
| 2.1–2.4 |
Label PRs |
Auto-suggest + human label low-confidence |
| 3.1–3.3 |
Reviews & Grouping |
Local agent summarizes each PR diff into CopilotSummary → (optional refresh) → group by label |
| 4.1–4.2 |
Summaries & Final |
Generate grouped summaries, then consolidate |
Detailed workflow docs
Do not read all steps at once—only read the step you are executing.
Available Scripts
| Script |
Purpose |
| dump-prs-since-commit.ps1 |
Fetch PRs between commits/tags |
| group-prs-by-label.ps1 |
Group PRs into CSVs |
| collect-or-apply-milestones.ps1 |
Assign milestones |
| diff_prs.ps1 |
Incremental PR diff |
| prepare-release-assets.ps1 |
Download installers + symbols from an ADO build, compute SHA256, emit the "Installer Hashes" markdown table for the GitHub release page |
| get-release-build-metadata.ps1 |
Resolve and validate the candidate build identity, version, channel, intent, and source commit |
| get-previous-published-release.ps1 |
Select the latest published stable or preview release that predates the candidate queue time |
| get-preview-release-delta.ps1 |
Calculate semantic added/removed PRs between exact release commits |
| collect-pr-metadata.ps1 |
Normalize GitHub metadata for an explicit set of PR numbers |
| new-preview-release-manifest.ps1 |
Create the auditable build, baseline, and semantic-delta release manifest |
| upsert-draft-preview-release.ps1 |
Create or update a draft prerelease without exposing a publish operation |
| verify-draft-preview-release.ps1 |
Verify draft flags, target commit, managed body, and uploaded assets |
References
Conventions
- Terminal usage: Disabled by default; only run scripts when user explicitly requests
- Preview automation: An explicit request to prepare a preview release, or invocation by the Prepare Preview Release agent, authorizes the canonical preview scripts
- Preview manifests: Keep
release-manifest.json and assets-manifest.json in the local audit package; do not upload either file as a GitHub release asset
- Preview note layout: Place the
Installer Hashes section immediately after the title and short public introduction, before Highlights and all change sections
- Batch generation: Generate ALL grouped_md files in one pass, then human reviews
- PR order: Preserve order from
sorted_prs.csv in all outputs
- Label filtering: Keeps
Product-*, Area-*, GitHub*, *Plugin, Issue-*
Troubleshooting
| Issue |
Solution |
gh command not found |
Install GitHub CLI and add to PATH |
| No PRs returned |
Verify milestone title matches exactly |
Empty CopilotSummary for many PRs |
Run Step 3.1 (local-agent summaries). Do not use mcp_github_request_copilot_review from a CLI/coding agent — the GitHub API rejects bot-initiated review requests, so the column will stay empty. |
| Many unlabeled PRs |
Return to labeling step before grouping |
prepare-release-assets.ps1 fails with "Failed to acquire ADO access token" |
Run az login and ensure you have access to the microsoft/Dart ADO project |
Candidate has no release-metadata.json |
The metadata resolver uses pipeline-log fallback; ambiguous or conflicting values stop the run |
| First preview after switching branches has unexpected changes |
Review removed-prs.json and unattributed-commits.json; see preview delta resolution |
1---2name: release-note-generation3description: Toolkit for generating PowerToys stable or preview release notes from GitHub milestones, commit ranges, or Azure DevOps release-candidate builds. Use when asked to create release notes, summarize milestone PRs, generate changelog, prepare a draft preview release, calculate PR deltas across main and stable, update release documentation, manage PR milestones, or prepare and validate release assets.4license: Complete terms in LICENSE.txt5---6
7# Release Note Generation Skill
8
9Generate professional PowerToys release notes by collecting merged PRs, summarizing each PR with the local CLI agent, grouping by label, and producing user-facing summaries. Stable and preview releases share the same PR metadata, attribution, grouping, and formatting rules.
10
11## Output Directory
12
13All generated artifacts are placed under `Generated Files/ReleaseNotes/` at the repository root (gitignored).
14
15```
16Generated Files/ReleaseNotes/
17├── milestone_prs.json # Raw PR data from GitHub
18├── sorted_prs.csv # Sorted PR list with Copilot summaries
19├── prs_with_milestone.csv # Milestone assignment tracking
20├── grouped_csv/ # PRs grouped by label (one CSV per label)
21├── grouped_md/ # Generated markdown summaries per label
22└── v{VERSION}-release-notes.md # Final consolidated release notes
23```
24
25Preview-release runs use an isolated subdirectory:
26
27```text
28Generated Files/ReleaseNotes/preview-<buildId>/
29├── release-context.json
30├── delta-commits.json
31├── delta-prs.json
32├── removed-prs.json
33├── unattributed-commits.json
34├── MemberList.md
35├── milestone_prs.json
36├── sorted_prs.csv
37├── release-notes.md
38├── hashes.md
39├── release-manifest.json # Local audit artifact; never uploaded
40├── assets-manifest.json # Local asset inventory; never uploaded
41└── final-review.md
42```
43
44## When to Use This Skill
45
46- Generate release notes for a milestone
47- Summarize PRs merged in a release
48- Generate per-PR review summaries locally for release-notes copy
49- Assign milestones to PRs missing them
50- Collect PRs between two commits/tags
51- Update README.md for a new version
52- Prepare GitHub release assets (download installers/symbols + compute hashes)
53- Prepare a complete draft preview release from an ADO build URL or build ID
54- Compare preview contents across `main` and `stable` branch transitions
55
56## Prerequisites
57
58- **GitHub CLI (`gh`) installed and authenticated** — The collection script uses `gh pr view` and `gh api graphql` to fetch PR metadata and co-author information. Run `gh auth status` to verify; if not logged in, run `gh auth login` first. See [Step 1.0.0](./references/step1-collection.md) for details.
59- MCP Server: github-mcp-server installed (used to fetch PR diffs/files for the local-agent review step)
60- For preview releases and [prepare-release-assets.ps1](./scripts/prepare-release-assets.ps1): **Azure CLI** authenticated against the Microsoft tenant (`az login`) with the `azure-devops` extension; access to the `microsoft/Dart` ADO project
61
62## Required Variables
63
64For a stable release, confirm `{{ReleaseVersion}}` with the user before starting.
65For a preview release, do not request a version: derive it from the candidate ADO build.
66
67| Variable | Description | Example |
68|----------|-------------|---------|
69| `{{ReleaseVersion}}` | Target release version | `0.98` |
70
71Preview mode instead requires one ADO build URL or numeric build ID. It derives the version, source commit, branch, and previous release without asking the user.
72
73## Scenario routing
74
75Read [the scenario index](./references/scenarios/index.md), then follow only the selected scenario:
76
77- [Stable release](./references/scenarios/stable-release.md) for milestone- or version-based release notes.
78- [Preview release](./references/scenarios/preview-release.md) for an autonomous ADO-build-to-draft workflow.
79
80## Workflow Overview
81
82```
83┌────────────────────────────────┐
84│ 1.0 Verify gh auth + MemberList │
85└────────────────────────────────┘
86 ↓
87┌────────────────────────────────┐
88│ 1.1 Collect PRs (stable range) │
89└────────────────────────────────┘
90 ↓
91┌────────────────────────────────┐
92│ 1.2 Assign Milestones │
93└────────────────────────────────┘
94 ↓
95┌────────────────────────────────┐
96│ 2.1–2.4 Label PRs (auto+human) │
97└────────────────────────────────┘
98 ↓
99┌────────────────────────────────┐
100│ 3.1 Local-agent PR summaries │
101│ (writes CopilotSummary) │
102└────────────────────────────────┘
103 ↓
104┌────────────────────────────────┐
105│ 3.2 (Optional) Refresh PR data │
106└────────────────────────────────┘
107 ↓
108┌────────────────────────────────┐
109│ 3.3 Group by label │
110│ (grouped_csv) │
111└────────────────────────────────┘
112 ↓
113┌────────────────────────────────┐
114│ 4.1 Summarize (grouped_md) │
115└────────────────────────────────┘
116 ↓
117┌────────────────────────────────┐
118│ 4.2 Final notes (v{VERSION}.md) │
119└────────────────────────────────┘
120```
121
122| Step | Action | Details |
123|------|--------|---------|
124| 1.0 | Verify prerequisites | `gh auth status` must pass; generate MemberList.md |
125| 1.1 | Collect PRs | From previous release tag on `stable` branch → `sorted_prs.csv` |
126| 1.2 | Assign Milestones | Ensure all PRs have correct milestone |
127| 2.1–2.4 | Label PRs | Auto-suggest + human label low-confidence |
128| 3.1–3.3 | Reviews & Grouping | Local agent summarizes each PR diff into `CopilotSummary` → (optional refresh) → group by label |
129| 4.1–4.2 | Summaries & Final | Generate grouped summaries, then consolidate |
130
131## Detailed workflow docs
132
133Do not read all steps at once—only read the step you are executing.
134
135- [Step 1: Collection & Milestones](./references/step1-collection.md)
136- [Step 2: Labeling PRs](./references/step2-labeling.md)
137- [Step 3: Reviews & Grouping](./references/step3-review-grouping.md)
138- [Step 4: Summarization](./references/step4-summarization.md)
139
140
141## Available Scripts
142
143| Script | Purpose |
144|--------|---------|
145| [dump-prs-since-commit.ps1](./scripts/dump-prs-since-commit.ps1) | Fetch PRs between commits/tags |
146| [group-prs-by-label.ps1](./scripts/group-prs-by-label.ps1) | Group PRs into CSVs |
147| [collect-or-apply-milestones.ps1](./scripts/collect-or-apply-milestones.ps1) | Assign milestones |
148| [diff_prs.ps1](./scripts/diff_prs.ps1) | Incremental PR diff |
149| [prepare-release-assets.ps1](./scripts/prepare-release-assets.ps1) | Download installers + symbols from an ADO build, compute SHA256, emit the "Installer Hashes" markdown table for the GitHub release page |
150| [get-release-build-metadata.ps1](./scripts/get-release-build-metadata.ps1) | Resolve and validate the candidate build identity, version, channel, intent, and source commit |
151| [get-previous-published-release.ps1](./scripts/get-previous-published-release.ps1) | Select the latest published stable or preview release that predates the candidate queue time |
152| [get-preview-release-delta.ps1](./scripts/get-preview-release-delta.ps1) | Calculate semantic added/removed PRs between exact release commits |
153| [collect-pr-metadata.ps1](./scripts/collect-pr-metadata.ps1) | Normalize GitHub metadata for an explicit set of PR numbers |
154| [new-preview-release-manifest.ps1](./scripts/new-preview-release-manifest.ps1) | Create the auditable build, baseline, and semantic-delta release manifest |
155| [upsert-draft-preview-release.ps1](./scripts/upsert-draft-preview-release.ps1) | Create or update a draft prerelease without exposing a publish operation |
156| [verify-draft-preview-release.ps1](./scripts/verify-draft-preview-release.ps1) | Verify draft flags, target commit, managed body, and uploaded assets |
157
158## References
159
160- [Sample Output](./references/SampleOutput.md) - Example summary formatting
161- [Detailed Instructions](./references/Instruction.md) - Legacy full documentation
162
163## Conventions
164
165- **Terminal usage**: Disabled by default; only run scripts when user explicitly requests
166- **Preview automation**: An explicit request to prepare a preview release, or invocation by the Prepare Preview Release agent, authorizes the canonical preview scripts
167- **Preview manifests**: Keep `release-manifest.json` and `assets-manifest.json` in the local audit package; do not upload either file as a GitHub release asset
168- **Preview note layout**: Place the `Installer Hashes` section immediately after the title and short public introduction, before `Highlights` and all change sections
169- **Batch generation**: Generate ALL grouped_md files in one pass, then human reviews
170- **PR order**: Preserve order from `sorted_prs.csv` in all outputs
171- **Label filtering**: Keeps `Product-*`, `Area-*`, `GitHub*`, `*Plugin`, `Issue-*`
172
173## Troubleshooting
174
175| Issue | Solution |
176|-------|----------|
177| `gh` command not found | Install GitHub CLI and add to PATH |
178| No PRs returned | Verify milestone title matches exactly |
179| Empty `CopilotSummary` for many PRs | Run Step 3.1 (local-agent summaries). Do **not** use `mcp_github_request_copilot_review` from a CLI/coding agent — the GitHub API rejects bot-initiated review requests, so the column will stay empty. |
180| Many unlabeled PRs | Return to labeling step before grouping |
181| `prepare-release-assets.ps1` fails with "Failed to acquire ADO access token" | Run `az login` and ensure you have access to the `microsoft/Dart` ADO project |
182| Candidate has no `release-metadata.json` | The metadata resolver uses pipeline-log fallback; ambiguous or conflicting values stop the run |
183| First preview after switching branches has unexpected changes | Review `removed-prs.json` and `unattributed-commits.json`; see [preview delta resolution](./references/preview-delta-resolution.md) |