# release-sdk-release-notes
Source: https://speakeasy.com/blog/release-sdk-release-notes


SDK changes should be transparent and easy to validate. Today, we're announcing comprehensive SDK release notes that serve two critical purposes: giving SDK maintainers detailed summaries on every pull request to validate changes, and providing end users with clear documentation to track how the SDK is evolving over time.

## 📋 PR summaries & commit messages for SDK maintainers

Every SDK generation results in a commit message that includes a comprehensive summary of the changes. Those commit messages, will be bundled into a PR summary that allows maintainers to easily validate SDK changes before clicking merge.

The commit message will also include a line for each change made to the SDK, including:

- **Added methods**: New functionality being introduced
- **Removed methods**: Deprecated functionality being removed (flagged as breaking)
- **Modified methods**: Changed signatures, parameters, or behavior
- **Breaking change indicators**: Clear warnings for any backward-incompatible changes

![PR Summary Example](/assets/blog/release-sdk-release-notes/pr_summary.png)

This improvement helps SDK maintainers with code review and maintain git history hygiene.

## 💬 Detailed release notes for SDK users

Every SDK user deserves to know what's new and what's changed in the SDKs they rely on. This release includes detailed release notes that provide a comprehensive overview of the changes in each version.

Once changes are validated and merged by maintainers, the detailed information becomes part of the SDK's public release notes:

- **Method-level change tracking**: See exactly which methods were added, modified, or removed
- **Breaking change visibility**: Clear indicators for any changes that could impact existing integrations
- **Change summary**: Easy-to-scan summaries that makes it easy for users to assess upgrade impacts

## Getting started

The feature works automatically with your existing Speakeasy workflow - no configuration changes required. Your next SDK update will include the enhanced release notes information in:

- Pull request descriptions
- Commit messages
- Release notes