fix: include README.md in published NuGet tool packages - #459
Open
GarrettBeatty wants to merge 1 commit into
Open
GarrettBeatty wants to merge 1 commit into
GarrettBeatty wants to merge 1 commit into
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
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.
Fixes #299
Root cause
The tool packages (
Amazon.Lambda.Tools,Amazon.ECS.Tools,Amazon.ElasticBeanstalk.Tools) were published to NuGet.org without a README. The shared MSBuild configbuildtools/common.propspackedLICENSEandicon.pngbut never declared or packed aPackageReadmeFile, so NuGet showed no package documentation.Fix
In
buildtools/common.props:<PackageReadmeFile>README.md</PackageReadmeFile>.<None Include=".../README.md" Pack="true" PackagePath="" />entry so the repo-rootREADME.mdis packed into each.nupkg.Because
common.propsis shared, this fixes all three tool packages at once.Versioning
Includes 3 AutoVer
Patchchange files (one per affected package), each with the changelog message "Include README.md in the published NuGet package."Reviewer notes
.nupkgcontents. No automated test guards regression here.