Versioning and Changelog
SDK update policy, breaking change management, and team announcements.
Versioning approach
Follow semantic versioning (major.minor.patch) for SDK updates:
- patch: bug fix, backward compatible
- minor: new feature, backward compatible
- major: breaking change
Internal update flow
- Read the changelog note.
- Run smoke tests in staging.
- If there is a breaking change, apply the migration step.
- Roll out to production gradually.
Recommended record format
- Update date
- Old/new version
- Affected domain flows (payments, webhooks, etc.)
- Rollback plan
Risk management
- Apply major updates during low-traffic windows.
- Use feature flags for controlled migration on breaking changes.
- Add the diff between two versions to the technical debt list.