-
Notifications
You must be signed in to change notification settings - Fork 751
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix missing readme entry in NuSpecs #4776
Conversation
Resolves dotnet#4722 `$(IsShipping)` is being set in one of the *.targets, which requires the readme setting to be done in a *.targets as well. While at it, move the definitions to Packaging.targets which is the better suited location.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this approach works too, Is there any issue of instead removing the condition entirely for PackageReadmeFile, and just have the one single package that violates this (the transport docs package) to either override the property or generate an empty README? Given property and item ordering, and how these ones being moved control many other things, I think that doing it that way would reduce the risk of this introducing a different hard-to-catch issue.
When it comes to MSBuild and import ordering, I usually try to pick the less risky change given it's hard to catch potential regressions with these changes.
If you still think that this is the right way to address the issue, I'm fine with it too, I would just ask that before merging we do a full diff of package contents and nuspec before and after the change, to ensure that we are getting the desired effect. |
This is the correct way to fix the issue. Before (the latest main):After (private build of this PR): |
Btw, if there's a desire to open the readmes in VS upon install, then those have to be The markdown readmes can be explored via the Solution Explorer > Depenendecies: |
I didn't mean to infer that your change doesn't work, I do believe that it works (and thanks for validating that 😃). I was just suggesting to consider a less-risky change that would also work which was keep properties where they were, and just removing the condition as it isn't necessary (once we add a dummy readme to the docs package). But anyway, I don't think this feedback is worth blocking this PR, so I'll go ahead and approve, and let you decide if you want to go with the less-risky alternative. |
Resolves #4722
$(IsShipping)
is being set in one of the *.targets, which requires the readme setting to be done in a *.targets as well.While at it, move the definitions to Packaging.targets which is the better suited location.
Microsoft Reviewers: Open in CodeFlow