open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Define language version compatibility requirements (#5983)

This commit is contained in:
jack-berg 2023-11-16 17:01:23 -06:00 committed by GitHub
parent 514d0820b2
commit 531898cd6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -66,10 +66,15 @@ We would love to hear from the larger community: please provide feedback proacti
## Requirements
Unless otherwise noted, all published artifacts support Java 8 or higher.
See [language version compatibility](VERSIONING.md#language-version-compatibility) for complete
details.
**Android Disclaimer:** For compatibility reasons, [library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) must be enabled.
**Android Disclaimer:** For compatibility
reasons, [library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring)
must be enabled.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional instructions for building this project for development.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional instructions for building this project for
development.
### Note about extensions

15
VERSIONING.md
View File

@ -61,6 +61,21 @@ you do not use classes in the `internal` package (which you MUST NOT do), you ca
your app will always function and have access to the latest features of OpenTelemetry without needing
any changes to code.
## Language Version Compatibility
The artifacts published by this codebase are compatible with certain language levels of tooling in
the Java ecosystem. For example, all artifacts (except where otherwise noted) support Java language
level 8 or higher, and the many artifacts intended to be used in Android environments adhere to a
particular [Android API level](https://developer.android.com/tools/releases/build-tools). The
following table defines the minimum language levels we adhere to, and how each is considered with
respect to semantic versioning.
| Language | Minimum Version | Applicability | Semconv Notes |
|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Java | 8+ | All artifacts, unless otherwise noted | Changing requires major version bump. |
| Android | 21+ (NOTE: [desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required. We stay up to date with the latest version of [desugar_jdk_libs](https://github.com/google/desugar_jdk_libs).) | Artifacts using `otel.animalsniffer-conventions` plugin | Kept in sync with minimum requirements for [Google Play services](https://developers.google.com/android/guides/setup). Subject to change in minor version. |
| Kotlin | 1.6+ | Only applies to `opentelemetry-extension-kotlin` | Kept in sync with [minimum non-deprecated](https://kotlinlang.org/docs/gradle-compiler-options.html#attributes-common-to-jvm-and-js) version. Subject to change in minor versions. |
## API vs SDK
This codebase is broadly split into two large pieces, the OpenTelemetry API and the OpenTelemetry SDK,