Skip to content

Commit 40ab17c

Browse files
add changelog info (#36570)
Co-authored-by: Catalina Peralta <[email protected]>
1 parent b5917d5 commit 40ab17c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

scripts/breaking_changes_checker/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,28 @@ Example:
8989
C:\azure-sdk-for-python\sdk\storage\azure-storage-blob> tox run -c ../../../eng/tox/tox.ini --root . -e breaking -- --latest-pypi-version
9090
```
9191

92+
### Changelog reporting
93+
94+
The breaking changes tool also supports reporting general changes between library versions. The changes will be reported in changelog format and will be reported as `### Breaking Changes` or `### Features Added`.
95+
96+
To get changelog output use the `--changelog` flag:
97+
98+
```
99+
C:\azure-sdk-for-python\sdk\storage\azure-storage-blob>tox run -c ../../../eng/tox/tox.ini --root . -e breaking -- --changelog
100+
```
101+
102+
Example output:
103+
104+
```
105+
### Breaking Changes
106+
107+
The model or publicly exposed class 'azure.contoso.widgetmanager.models.Widget' had its instance variable 'bar' deleted or renamed in the current version
108+
109+
### Features Added
110+
111+
The model or publicly exposed class 'azure.contoso.widgetmanager.models.Widget' had property 'foo' added in the current version
112+
```
113+
92114
### Generating code reports
93115

94116
The breaking changes tools also supports generating a code report for a given library which can later be used as an input for breaking changes comparison.

0 commit comments

Comments
 (0)