Skip to content

Commit 9880758

Browse files
Merge branch 'dev' into agent-assist/azure-azure-cli-issue-34187-e16a8bbe24e1
2 parents 0ca5237 + cc010d2 commit 9880758

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
applyTo: "{src/azure-cli/HISTORY.rst,src/azure-cli-core/HISTORY.rst}"
3+
description: "Do not manually edit HISTORY.rst files; release history is generated automatically."
4+
---
5+
6+
When reviewing or editing changes in this repository:
7+
8+
- Do **not** manually add, modify, or delete entries in any `HISTORY.rst` file
9+
(for example `src/azure-cli/HISTORY.rst` or `src/azure-cli-core/HISTORY.rst`).
10+
Release history notes are generated automatically from PR titles and descriptions
11+
by the release pipeline (`scripts/release/generate_history_notes.py`).
12+
- During PR review, if a pull request contains manual changes to a `HISTORY.rst`
13+
file, request that the author revert those changes while preserving the
14+
functional (non-`HISTORY.rst`) changes. Reviewers consistently ask contributors
15+
to "revert the changes to the HISTORY.rst, as the history notes would be
16+
generated automatically."
17+
- To control what appears in the release history, use the PR title and the
18+
`History Notes` section of the PR description instead of editing `HISTORY.rst`:
19+
- A `[Component Name]` title prefix marks a customer-facing change that will be
20+
added to `HISTORY.rst`; a `{Component Name}` prefix marks a change that will
21+
**not** be included.
22+
- See `doc/authoring_command_modules/README.md` ("Format PR Title" and
23+
"Format PR Description") for the required format.
24+
- The only exception is a **Hotfix** PR targeting the `release` branch: per
25+
`doc/authoring_command_modules/README.md`, customer-facing hotfixes must
26+
manually add their history notes because the auto-generated notes ignore
27+
PRs marked `Hotfix`. Outside this hotfix flow, manual `HISTORY.rst` edits
28+
should be reverted.

0 commit comments

Comments
 (0)