Add package readmes to illink NuGet packages stating SDK-only support #123505
+35
−2
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
Co-authored-by: agocke <515774+agocke@users.noreply.github.com>
dotnet-policy-service
bot
added
the
linkable-framework
Copilot
AI
changed the title
[WIP] Update Illink NuGet packages readme to state support contract
Add package readmes to illink NuGet packages stating SDK-only support
Jan 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds package readme files to the Microsoft.NET.ILLink and Microsoft.NET.ILLink.Tasks NuGet packages to document that these packages are SDK-internal and should not be directly referenced by users.
Changes:
- Added
PACKAGE.mdfiles to both illink packages with "Do not directly reference" warnings and trimming documentation links - Enabled package readme inclusion in project files by adding/removing
EnableDefaultPackageReadmeFileproperties
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/tools/illink/src/linker/PACKAGE.md | New package readme for Microsoft.NET.ILLink stating SDK-only usage and providing trimming documentation links |
| src/tools/illink/src/linker/Mono.Linker.csproj | Added EnableDefaultPackageReadmeFile=true to include the PACKAGE.md file in the NuGet package |
| src/tools/illink/src/ILLink.Tasks/PACKAGE.md | New package readme for Microsoft.NET.ILLink.Tasks stating SDK-only usage and providing trimming documentation links |
| src/tools/illink/src/ILLink.Tasks/ILLink.Tasks.csproj | Removed TODO comment and EnableDefaultPackageReadmeFile=false to enable package readme inclusion |
sbomer
approved these changes
Jan 22, 2026
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.
Description
The
Microsoft.NET.ILLinkandMicrosoft.NET.ILLink.TasksNuGet packages are published but lack documentation indicating they're SDK-internal and unsupported for direct consumption.Changes
PACKAGE.mdfiles to both packages with clear "Do not directly reference this package" language matching other SDK-internal packages likeMicrosoft.NETCore.AppEnableDefaultPackageReadmeFile=falsefromILLink.Tasks.csprojand addingEnableDefaultPackageReadmeFile=truetoMono.Linker.csprojBoth readmes follow the standard repository PACKAGE.md structure with About, How to Use, Additional Documentation, and Feedback sections.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.