Bruno Pedro


Found at “Semantic Versioning 2.0.0 | Semantic Versioning” on 2024-08-22 13:20:14 +02:00.

Should you increase the API version when deprecating one or more operations?

Deprecating existing functionality is a normal part of software development and is often required to make forward progress. When you deprecate part of your public API, you should do two things: (1) update your documentation to let users know about the change, (2) issue a new minor release with the deprecation in place. Before you completely remove the functionality in a new major release there should be at least one minor release that contains the deprecation so that users can smoothly transition to the new API.