Versioning & Breaking Changes

The SDK strives towards maintaining backward compatibility for a reasonable time. This ensures that client applications can safely upgrade to newer versions of the SDK without resolving a large number of breaking changes. For a more in-depth explanation of what constitutes a breaking change in rust, see the SemVer Compatibility section in the Cargo book.

There may be certain functionality that is actively being developed and is not yet stable. In these cases, they should be marked as such and gated behind a unstable feature flag. Consuming client applications should avoid merging changes that depend on these features into main.

Public APIs

To track breaking changes to the public APIs for Secrets Manager, we use a changelog file in the bitwarden crate. This file should be updated with noteworthy changes.