Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.72 KB

VERSIONING.md

File metadata and controls

33 lines (19 loc) · 2.72 KB
Raw

Versioning Policy

The AWS SDK for Java v2 uses a versioning scheme that follows the format: MAJOR.MINOR.PATCH[-QUALIFIER]. Revisions to different version components communicate the risk associated with changes when upgrading to newer versions of the SDK:

  • MAJOR - Huge changes, expect API incompatibilities and other breaking changes.
  • MINOR - Medium risk changes. Upgrading SHOULD usually just work but check the release notes. Example changes might include incrementing minimum Java version, deprecating APIs, or significant changes to core runtime components. Changes to MINOR version MAY contain backwards incompatible changes under certain scenarios.
  • PATCH - Zero to low risk changes. New features and bug fixes that should be safe to consume without much worry.
  • QUALIFIER - (Optional) Additional release version qualifier (e.g. PREVIEW). Most releases are not expected to have a qualifier.

The AWS SDK for Java v2 does NOT follow strict semantic versioning. Patch releases may contain new features in addition to bug fixes. See the FAQ for rationale.

Stability of the AWS SDK for Java

For information about maintenance and support of SDK major versions and their underlying dependencies, see the following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:

Component Versioning

The SDK versions all service clients (e.g. S3, EC2, DynamoDb, etc) and the runtime (e.g. aws-config) together under a single version. This allows customers to easily upgrade multiple SDK clients at once and keep dependencies, such as the core runtime, compatible. The SDK may in the future consider versioning service clients separately from one another.

Internal APIs

Any API marked with either @SdkInternalApi or @SdkTestInternalApi is not subject to any backwards compatibility guarantee. These are meant to be consumed only by the SDK and may be changed or removed without notice. The SDK MAY bump the MINOR version when making such a change.

FAQ

Why does the SDK not follow semantic versioning (semver)?

Under semver we’d NEVER use the PATCH component. The SDK does daily releases containing updates to AWS service models. These changes go out with bug fixes every day. That means for us and customers the PATCH version would just be useless, it would always be zero. The intention behind this versioning scheme is to allow customers to weigh the relative risk and/or cost associated with updating to a newer SDK version.