feat(release): ship archives without sidecar symbols or XML docs - #189
Merged
Conversation
A downloaded CLI is four files, not thirty-two: symbols move inside the assemblies so a user's stack trace keeps its line numbers, and the XML doc comments stay in the NuGet package where a consumer of the types would look for them.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The per-RID archives held 32 files, of which 4 were the point:
.pdb.xmldoc commentsVisible when installing through mise, which extracts the archive onto
PATH— 32 files land where one binary was wanted. The NuGet package is a separate artifact built bydotnet packand keeps its own shape; what needed fixing was the archive, whose audience downloads it and runs it.XML docs
Excluded at archive time. They describe an API surface to a compiler, and the consumer who would read them is using the NuGet package, not a zip. Still generated, so the analyzer discipline and the package are unaffected.
Symbols: embedded rather than dropped
Deleting the
.pdbfiles would have been the easy half of this, and it costs something real — a stack trace in a bug report loses its line numbers as soon as the sidecar goes missing, which for a downloaded archive is "immediately".DebugType=embeddedputs them inside the assemblies instead, so they cannot be separated from the code they describe.Measured on the same commit, win-x64 self-contained:
.pdbThe download gets smaller overall — +0.44 MB of binary against 0.74 MiB of removed sidecars — and simpler.
Verified
Published linux-x64 self-contained with the change and applied the archive's exclusion: 4 entries —
ivicli,LICENSE-MIT,LICENSE-APACHE,THIRD-PARTY-NOTICES.md— from an 18-file publish directory. Full build and test suite clean (12 assemblies).Nothing downstream needed adjusting: the AOT Dockerfile already removed
*.pdb/*.xml(now a no-op for pdb), and the AURivi-cliPKGBUILD already filtered both.