Improve NuGet package metadata, README and Source Link#17
Merged
Conversation
Add RepositoryUrl/RepositoryType/PackageProjectUrl, pack the root README via PackageReadmeFile, and reference Microsoft.SourceLink.GitHub for the WLED and WLED.DependencyInjection packages so nuget.org links back to the repo, renders the README, and ships working Source Link. Adds plans/15-nuget-package-metadata.md and updates the roadmap and changelog.
There was a problem hiding this comment.
Pull request overview
Improves NuGet packaging by publishing repository/project URLs and git repository type from Directory.Build.props, packing the root README.md as the rendered package README for both WLED and WLED.DependencyInjection, and adding Microsoft.SourceLink.GitHub to enable Source Link debugging. Also documents the work via plans/15-nuget-package-metadata.md, updates plans/README.md, and records the change in CHANGELOG.md.
Changes:
- Add shared
RepositoryUrl/RepositoryType/PackageProjectUrltoDirectory.Build.props. - Add
PackageReadmeFile, pack../../README.md, and referenceMicrosoft.SourceLink.GitHub8.0.0 in both packable csprojs. - Add Plan 15 doc and update
plans/README.mdandCHANGELOG.md.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Directory.Build.props | Adds repo/project URL metadata applied to all projects. |
| src/Kevsoft.WLED/Kevsoft.WLED.csproj | Adds README packaging and Source Link reference. |
| src/Kevsoft.WLED.DependencyInjection/Kevsoft.WLED.DependencyInjection.csproj | Same packaging metadata for DI package. |
| plans/15-nuget-package-metadata.md | New plan documenting rationale and approach. |
| plans/README.md | Adds Plan 15 (but also duplicates rows for 12–14). |
| CHANGELOG.md | Records the packaging improvements under Unreleased → Changed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| <ItemGroup> | ||
| <None Include="../../icon.png" Pack="true" Visible="false" PackagePath="" /> | ||
| <None Include="../../README.md" Pack="true" Visible="false" PackagePath="" /> |
Comment on lines
+67
to
+70
| | 12 | [Usability & correctness improvements](12-usability-and-correctness-improvements.md) | Quality | | ||
| | 13 | [Device ergonomics & agent guidance](13-device-ergonomics-and-agent-guidance.md) | Quality | | ||
| | 14 | [HttpClient connection lifetime & DNS staleness](14-httpclient-connection-lifetime.md) | Reliability | | ||
| | 15 | [NuGet package metadata, README & Source Link](15-nuget-package-metadata.md) | Packaging | |
The pack stage failed with NU5019 (File not found: '/README.md') because the new PackageReadmeFile content was never copied into the build context. Copy README.md alongside icon.png. Also copy ./.git (and stop ignoring it) so Microsoft.SourceLink.GitHub can resolve the commit and emit real source link information instead of warning that source control information is unavailable.
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
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.
Add RepositoryUrl/RepositoryType/PackageProjectUrl, pack the root README via PackageReadmeFile, and reference Microsoft.SourceLink.GitHub for the WLED and WLED.DependencyInjection packages so nuget.org links back to the repo, renders the README, and ships working Source Link.
Adds plans/15-nuget-package-metadata.md and updates the roadmap and changelog.