Commit 0b9b34d
Add package readmes to illink NuGet packages stating SDK-only support (#123505)
## Description
The `Microsoft.NET.ILLink` and `Microsoft.NET.ILLink.Tasks` NuGet
packages are published but lack documentation indicating they're
SDK-internal and unsupported for direct consumption.
## Changes
- **Added `PACKAGE.md` files** to both packages with clear "Do not
directly reference this package" language matching other SDK-internal
packages like `Microsoft.NETCore.App`
- **Enabled package readme inclusion** by removing
`EnableDefaultPackageReadmeFile=false` from `ILLink.Tasks.csproj` and
adding `EnableDefaultPackageReadmeFile=true` to `Mono.Linker.csproj`
- **Included trimming documentation links** for users who need guidance
on proper trimming usage through the SDK
Both readmes follow the standard repository PACKAGE.md structure with
About, How to Use, Additional Documentation, and Feedback sections.
<!-- START COPILOT ORIGINAL PROMPT -->
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>Illink nuget packages should state support contract in
package readme</issue_title>
> <issue_description>The illink packages aren’t supported outside of use
by the SDK. We should state that in the readme. </issue_description>
>
> ## Comments on the Issue (you are @copilot in this section)
>
> <comments>
> </comments>
>
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes #123504
<!-- START COPILOT CODING AGENT TIPS -->
---
💡 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](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: agocke <515774+agocke@users.noreply.github.com>1 parent 23b6046 commit 0b9b34d
File tree
4 files changed
+35
-2
lines changed- src/tools/illink/src
- ILLink.Tasks
- linker
4 files changed
+35
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
23 | 21 | | |
24 | 22 | | |
25 | 23 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
0 commit comments