Repository navigation
{Misc.} Add Copilot instructions to prevent manual HISTORY.rst edits - #34202
Merged
Yeming Liu (isra-fel) merged 2 commits intoOct 9, 2026
Merged
Yeming Liu (isra-fel) merged 2 commits into
Yeming Liu (isra-fel) merged 2 commits into
Conversation
Release history notes are generated automatically from PR titles and descriptions. Add a .github/instructions file so GitHub Copilot flags manual HISTORY.rst changes during PR review and requests reverts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4b6414b3-5257-4e50-bf71-865cf4cc38b6
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The glob incorrectly covers changelogs not managed by the referenced generation script.
1 open finding
What changed in this PR
Adds Copilot review guidance to prevent manual edits to auto-generated release histories.
Changes:
- Adds scoped
HISTORY.rstreview instructions. - Documents title/description generation and the hotfix exception.
| File | Description |
|---|---|
.github/instructions/history-rst.instructions.md |
Defines release-history editing guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Update applyTo path for HISTORY.rst instructions. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Ethan Yang (necusjz)
approved these changes
Oct 9, 2026
Yeming Liu (isra-fel)
deleted the
docs/history-rst-copilot-instructions
branch
October 9, 2026 06:44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related command
N/A (repository tooling / GitHub Copilot review instructions)
Description
Release history notes in
HISTORY.rstare generated automatically from PR titles and descriptions by the release pipeline (scripts/release/generate_history_notes.py), and reviewers routinely ask contributors to revert manual edits to these files. This PR adds a.github/instructions/history-rst.instructions.mdfile (scoped viaapplyTo: "**/HISTORY.rst") so GitHub Copilot can detect and flag manualHISTORY.rstchanges during PR review and request a revert while preserving functional changes.The guidance mirrors existing reviewer feedback, e.g.:
src/azure-cli/HISTORY.rst, since release history is generated automatically."It also documents the Hotfix exception described in
doc/authoring_command_modules/README.md.Testing Guide
Documentation/tooling-only change (no code). The new file follows the same frontmatter format as the existing
.github/instructions/*.instructions.mdfiles and is auto-discovered by itsapplyTo/descriptionfrontmatter.History Notes