-
Notifications
You must be signed in to change notification settings - Fork 309
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.
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
set an explicit version range for the @opentelemetry/api #4318
Conversation
Overall package sizeSelf size: 6.48 MB Dependency sizes
🤖 This report was automatically generated by heaviest-objects-in-the-universe |
There is the peerDependenciesMeta field for that. Please note that an optional peer dependency might then be missing in the installation and you'll need to make sure any require calls are done in try/catch and have some defined behavior when it is not there. The way it is now, all users are still implicitly installing it. |
What does this PR do?
sets an explicit version range for the @opentelemetry/api
Motivation
#3654
TLDR:
"Short version: an SDK implementation should expect that minor versions of the API may include new methods. Minor version stability is guaranteed for users but not implementers. The OpenTelemetry authors recommend the following: dd-trace should define not only a minimum API level but also a maximum"
the version maximum is set to <1.9.0 which is expected to break us:
open-telemetry/opentelemetry-js#4677 (comment)
Additional Notes
Should we take the approach of listing the supported version range as a "peerDependencies"? Although it will ensure that users install the supported versions of the @opentelemetry/api it will also force users not using the @opentelemetry/api to have to install it.