-
Notifications
You must be signed in to change notification settings - Fork 845
[Infra] Match runtime packages to runtime major version #6327
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
base: main
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6327 +/- ##
==========================================
+ Coverage 86.66% 86.72% +0.05%
==========================================
Files 258 258
Lines 11878 11878
==========================================
+ Hits 10294 10301 +7
+ Misses 1584 1577 -7
Flags with carried forward coverage won't be shown. Click here to find out more. |
Directory.Packages.props
Outdated
However, for .NET 8 we need to use the .NET 9 package as the following APIs have been used to expose user-facing functionality: | ||
- System.Diagnostics.Activity.ctor(string, string, IEnumerable<KeyValuePair<string, object>>) | ||
- System.Diagnostics.Activity.AddException() | ||
- System.Diagnostics.Activity.AddLink() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe this could be phrased to indicate that we need to (and can) use the latest version.
We, most likely, can use 10.0.x for all targets, like we can use 9.0.x.
For that matter, I'd use a property specific for this package's version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Depends on the resolution to this comment:
Moving forward to preserve the intention of this PR we would need to accept that new functionality would be gated to upgrading to the matching version of .NET. For example, a new feature added in .NET 10 would require your application to net10.0 to use it.
Alternatively we could take an approach where we only expose new APIs to older runtimes when the version is itself an LTS version.
The PR as-is is working on the assumption new things need newer TFMs/versions, so the MSBuild as-written is correct as it would only have an exception for net8.0
and code would need to use #if NET10_0_OR_GREATER
-like constructs as appropriate for future API additions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've also written it with #6307 in mind, where if this was merged as-is it would just add these changes:
- <RuntimePackageVersions>9.0.0</RuntimePackageVersions>
+ <RuntimePackageVersions>10.0.0</RuntimePackageVersions>
+ <RuntimePackageVersions Condition="'$(TargetFramework)' == 'net10.0'">10.0.0</RuntimePackageVersions>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be prepared, but I'd reason about TFM specific stuff when we get there.
Polyfills are always an option. 😄
Try using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will help with conflict versions of Microsoft.Extensions.*
when using opentelemetry-dotnet-auto
a505b06
to
1361467
Compare
67a3cef
to
46bf852
Compare
d8c6162
to
9c25441
Compare
85c7f3d
to
68c01ab
Compare
This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or pushing will instruct the bot to automatically remove the label. This bot runs once per day. |
This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or pushing will instruct the bot to automatically remove the label. This bot runs once per day. |
5f99c8d
to
921303a
Compare
@martincostello, @rajkumar-rangaraj, I have a question about last discussion topics. As I understand, the goal is to keep Based on https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core. It works for most cases, but keep in mind, that we can have a security issues coverage in that case: In general, it will be great to have it implemented. The only concern I see is the half year period for lack of security fixes for .NET8. |
Yeah that's an unfortunate side-effect of us wanting to make this change in an LTS year. I think the mitigations to that are:
|
921303a
to
d9b5cb0
Compare
I'm just writing up the issue discussed in yesterday's SIG, and the security issue is less of a concern as the PR as it currently stands only has Users on .NET 8 for the last 6 months of its release cycle will be using Based on that, the only users affected by the end-of-life of .NET 9 will be users affected by that regardless of whether they use OpenTelemetry or not. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the OpenTelemetry .NET project to match runtime package versions to the major version of the target framework, addressing user requests to align dependency versions with their chosen .NET version (LTS vs STS). The change ensures that applications targeting specific .NET versions receive matching package versions, while providing flexibility for users who want to upgrade dependencies independently.
Key changes:
- Runtime packages now align to target framework major version (e.g., net8.0 uses 8.0.x packages)
- System.Diagnostics.DiagnosticSource maintains latest version across all frameworks to preserve OpenTelemetry functionality
- Special handling for net8.0 with Microsoft.Extensions.Configuration.Binder upgraded to 8.0.2
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
Directory.Packages.props | Updates package versioning strategy to match runtime versions to target frameworks |
src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj | Adds explicit Microsoft.Extensions.Configuration.Binder upgrade for net8.0 |
test/OpenTelemetry.Extensions.Hosting.Tests/OpenTelemetry.Extensions.Hosting.Tests.csproj | Enables System.Text.Json package references for net8.0 testing |
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests.csproj | Enables System.Text.Json package references for net8.0 testing |
issue-summary.md | Adds comprehensive documentation explaining the dependency versioning strategy change |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
6085ece
to
f962c36
Compare
f962c36
to
f1dc69d
Compare
f1dc69d
to
6dc7587
Compare
Squashed commits as EasyCLA is still complaining about commits co-authored by Copilot. |
26b0cff
to
ff86fef
Compare
Use .NET 8 packages with `net8.0`, except `System.Diagnostics.DiagnosticSource`. Resolves open-telemetry#5973.
Use syntax that would avoid renovate trying to update these versions (see open-telemetry#6459).
- Use syntax for "pinning" for `RuntimePackageVersions`. - Simplify syntax for `OTelLatestStableVer`.
The previous syntax is relied upon for automation.
ff86fef
to
8af9406
Compare
FYI - we announced https://devblogs.microsoft.com/dotnet/dotnet-sts-releases-supported-for-24-months/. I don't think that changes the direction in this PR. But it is related information. |
Add changes missing from previous merge commit.
#5973 (comment)
Changes
Refactoring to match runtime packages to the major version of a target framework.
Unfortunately we can't do this complete for
net8.0
without making breaking changes as we have exposed functionality that depends on new APIs added in theSystem.Diagnostics.DiagnosticSource
package for9.0.0
.opentelemetry-dotnet/src/OpenTelemetry.Api/Trace/TracerProvider.cs
Line 80 in 3f86f47
opentelemetry-dotnet/src/OpenTelemetry.Api/Trace/TelemetrySpan.cs
Line 375 in 3f86f47
opentelemetry-dotnet/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs
Line 125 in 3f86f47
As a compromise for
net8.0
,8.0.x
packages are used for all dependencies exceptSystem.Diagnostics.DiagnosticSource
which uses9.0.0
to preserve these use cases.The downside here is that users running
net8.0
will technically be out of support for that package from May 2026, but that's still the case if we do nothing.We could mitigate this by moving the special case for
net8.0
to depend on the10.0.0
package in November with a new release for .NET 10 (if that works) or users can self-mitigate by adding an explicit reference to the10.0.0
version of that package to their own application without upgrading to .NET 10 immediately.Moving forward to preserve the intention of this PR we would need to accept that new functionality would be gated to upgrading to the matching version of .NET. For example, a new feature added in .NET 10 would require your application to
net10.0
to use it.Alternatively we could take an approach where we only expose new APIs to older runtimes when the version is itself an LTS version.
In that case, a new API added in .NET 10 would be supported in all previous versions as we know the package exposing it is LTS, but a new API added in .NET 11 would only be available to
net11.0
and later as that is STS.Merge requirement checklist
CHANGELOG.md
files updated for non-trivial changes