Add Copilot instructions for PR labeling - #5532
Andy Jordan (andyleejordan) merged 3 commits into
Conversation
Sorry, something went wrong.
There was a problem hiding this comment.
Pull request overview
This PR adds a "Pull Request Labels" section to .github/copilot-instructions.md so that Copilot-authored PRs are properly labeled for triage and changelog generation. Without this guidance, Copilot PRs lacked the required Area-* and Issue-* labels, causing them to be miscategorized in auto-generated release notes.
Changes:
- Added labeling instructions requiring at least one Area-* label and exactly one Issue-* label per PR, with guidance on OS-* and Ignore labels.
- Documented the relationship between Issue-* labels and the changelog categories defined in .github/release.yml.
- Directed Copilot to discover the current label set dynamically via gh label list rather than relying on a hard-coded list.
Sorry, something went wrong.
| - **Exactly one `Issue-*` label** describing the kind of change: | ||
| - `Issue-Bug` — a bug fix. | ||
| - `Issue-Enhancement` — a new feature or changed behavior. | ||
| - `Issue-Performance` — a performance improvement. | ||
|
|
||
| The `Issue-*` label is not optional: GitHub's auto-generated release notes use it | ||
| to pick the changelog category. See [`.github/release.yml`](./release.yml) for the | ||
| authoritative mapping (`Issue-Enhancement` → "Enhancements & Features ✨", | ||
| `Issue-Bug` → "Squashed Bugs 🐛"). Any PR **without** an `Issue-*` label falls | ||
| through the `"*"` catch-all into "Other Changes 🙏" and is silently | ||
| miscategorized, so always set one correctly. |
There was a problem hiding this comment.
Added Issue-Performance to .github/release.yml with its own "Performance Improvements ⚡" category (commit Add Issue-Performance category to release.yml). PRs labeled Issue-Performance will now land in that section instead of the catch-all "Other Changes 🙏".
Sorry, something went wrong.
Copilot-authored PRs in this repo were not being labeled, so they were mis-triaged and miscategorized in the auto-generated changelog. This mirrors PowerShellEditorServices#2310, adapted to this repository's labels and .github/release.yml.
Changes
The Issue-* guidance is tied to the changelog mapping in .github/release.yml (Issue-Enhancement → "Enhancements & Features ✨", Issue-Bug → "Squashed Bugs 🐛"), noting that a missing Issue-* label falls through the "*" catch-all into "Other Changes 🙏".