Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Codify that we may stop publishing artifacts, and change unstable por… #4729

Merged
merged 3 commits into from Sep 7, 2022
Merged

Codify that we may stop publishing artifacts, and change unstable por… #4729

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e01d86
Codify that we may stop publishing artifacts, and change unstable por…
jack-berg Sep 1, 2022
468b103
Revert ABI -> API
jack-berg Sep 2, 2022
f1d8bae
PR feedback
jack-berg Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions VERSIONING.md
View file
Open in desktop
Expand Up @@ -31,6 +31,17 @@ changes are:
Such changes will be avoided - if they must be made, the `MAJOR` version of the artifact will be
incremented.

A stable artifact may depend on an `-alpha` artifact, and expose classes, interfaces, enums, etc. of
the `-alpha` artifact as part of its public API. In these cases, the stable artifact will place
an [implementation](https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_separation)
dependency (as opposed to an api dependency) on the `-alpha` artifact. In order to consume the
portions of the API related to the `-alpha` artifact, a user must place its own implementation
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
dependency on it. In adding the implementation dependency, the user has opted into to using
an `-alpha` artifact, and we reserve the right to change the portions of the API pertaining to
the `-alpha` artifact. This includes changing the names of methods, return types, argument types, etc.
We will use this technique sparingly and only when there is some significant reduction in friction
by including the `-alpha` artifact.

Backwards incompatible changes to `internal` packages are expected. Versions of published artifacts
are expected to be aligned by using BOMs we publish. We will always provide BOMs to allow alignment
of versions.
Expand All @@ -39,6 +50,12 @@ Changes may be made that require changes to the an app's dependency declarations
incrementing the version on `MINOR` version updates. For example, code may be separated out to a
new artifact which requires adding the new artifact to dependency declarations.

On rare occasions we may deprecate an entire stable artifact, with the intent of stopping functional
changes or enhancements. In these situations we may stop publishing additional `MINOR` or `MAJOR`
versions of the artifact. However, if necessary, we'll publish security fixes via `PATCH` releases.
Despite stopping publishing, the BOM will continue to reference the last published version of the
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
artifact, and the API of the last published version will remain stable.

As a user, if you always depend on the latest version of the BOM for a given `MAJOR` version, and
you do not use classes in the `internal` package (which you MUST NOT do), you can be assured that
your app will always function and have access to the latest features of OpenTelemetry without needing
Expand Down