Repository navigation
{Misc.} Add Copilot instructions to prevent manual HISTORY.rst edits #34202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Yeming Liu (isra-fel)
merged 2 commits into
Azure:dev
from
isra-fel:docs/history-rst-copilot-instructions
Oct 9, 2026
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| applyTo: "**/HISTORY.rst" | ||
| description: "Do not manually edit HISTORY.rst files; release history is generated automatically." | ||
| --- | ||
|
|
||
| When reviewing or editing changes in this repository: | ||
|
|
||
| - Do **not** manually add, modify, or delete entries in any `HISTORY.rst` file | ||
| (for example `src/azure-cli/HISTORY.rst` or `src/azure-cli-core/HISTORY.rst`). | ||
| Release history notes are generated automatically from PR titles and descriptions | ||
| by the release pipeline (`scripts/release/generate_history_notes.py`). | ||
| - During PR review, if a pull request contains manual changes to a `HISTORY.rst` | ||
| file, request that the author revert those changes while preserving the | ||
| functional (non-`HISTORY.rst`) changes. Reviewers consistently ask contributors | ||
| to "revert the changes to the HISTORY.rst, as the history notes would be | ||
| generated automatically." | ||
| - To control what appears in the release history, use the PR title and the | ||
| `History Notes` section of the PR description instead of editing `HISTORY.rst`: | ||
| - A `[Component Name]` title prefix marks a customer-facing change that will be | ||
| added to `HISTORY.rst`; a `{Component Name}` prefix marks a change that will | ||
| **not** be included. | ||
| - See `doc/authoring_command_modules/README.md` ("Format PR Title" and | ||
| "Format PR Description") for the required format. | ||
| - The only exception is a **Hotfix** PR targeting the `release` branch: per | ||
| `doc/authoring_command_modules/README.md`, customer-facing hotfixes must | ||
| manually add their history notes because the auto-generated notes ignore | ||
| PRs marked `Hotfix`. Outside this hotfix flow, manual `HISTORY.rst` edits | ||
| should be reverted. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.