Skip to content

Commit

Permalink
add changelog info (#36570)
Browse files Browse the repository at this point in the history
Co-authored-by: Catalina Peralta <caperal@microsoft.com>
  • Loading branch information
catalinaperalta and cperaltah authored Jul 23, 2024
1 parent b5917d5 commit 40ab17c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions scripts/breaking_changes_checker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,28 @@ Example:
C:\azure-sdk-for-python\sdk\storage\azure-storage-blob> tox run -c ../../../eng/tox/tox.ini --root . -e breaking -- --latest-pypi-version
```

### Changelog reporting

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`.

To get changelog output use the `--changelog` flag:

```
C:\azure-sdk-for-python\sdk\storage\azure-storage-blob>tox run -c ../../../eng/tox/tox.ini --root . -e breaking -- --changelog
```

Example output:

```
### Breaking Changes
The model or publicly exposed class 'azure.contoso.widgetmanager.models.Widget' had its instance variable 'bar' deleted or renamed in the current version
### Features Added
The model or publicly exposed class 'azure.contoso.widgetmanager.models.Widget' had property 'foo' added in the current version
```

### Generating code reports

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.
Expand Down

0 comments on commit 40ab17c

Please sign in to comment.