Modernize NuGet Packages #303
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… can get feedback about Source Link and Deterministic Builds.
…ties, so we can get feedback about packaging format/content and Deterministic Builds.
…ministic builds. This change was suggested by the following output from the `dotnet-validate` package validation tool: > Deterministic (dll/exe): ❌ Non deterministic > Ensure that the following property is enabled for CI builds > and you're using at least the 2.1.300 SDK: > <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
…not even supported by NuGet.org's symbol server and were redundant in our case due to favoring DebugType 'embedded'.
…ted by NuGet.org's symbol server. Since this places symbols in the symbols package, we stop also embedding them in the dll files, reducing download size for most users.
bdfb92d to
9415a44
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Historically, although our packaging worked, it became confused over time by shifting guidance and available tooling. All packaged assemblies used
<DebugType>embedded<DebugType>, which makes the most sense when you are not publishing a separate symbols package, but we were attempting to publish such a package. The symbols package we were building, however, was of the legacy format, so it was not actually taking part. This undesirable combination worked for end users, though, since the embedded symbol data made up for the missing symbol package.Additionally, we stand to benefit from enabling deterministic builds during CI, now that .NET 8 applies Source Link automatically and is better served by leveraging this optional feature.
This modernizes our packages to the latest guidance in the .NET 8 era:
Note that this change results in an incorrect warning from NuGet during
dotnet pack, complaining that the TestAdapter package is missing its README. This is simply not the case, and the incorrect warning text appears to be an unintentional side effect of the atypical combination of modern symbols packaging with an old fashioned nuspec. The README is included in the package.Packaging Status Before This PR
(Obtained with
dotnet build src/$project -c Release --nologo --getProperty:$propertyanddotnet validate package local $package)Packaging Status After This PR