Copy XmlDocuments to output directory #10579
Merged
Conversation
This file contains 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
brettfo
reviewed
Dec 1, 2020
| @@ -6,12 +6,16 @@ | |||
| <dependencies> | |||
| <group targetFramework=".NETStandard2.0" /> | |||
| </dependencies> | |||
| <contentFiles> <!-- Deploy doc comments as Content --> | |||
| <files include="**/*" buildAction="None" copyToOutput="true" flatten="true" /> | |||
There was a problem hiding this comment.
Does this pick up anything other than the XML file? How do we know? I'm concerned that this will pull in a bunch of garbage.
There was a problem hiding this comment.
@brettfo, it only picks up contentFiles. I think I can specify the exact filename though.
There was a problem hiding this comment.
There it's 'splicit now.
brettfo
approved these changes
Dec 1, 2020
nosami
pushed a commit
to xamarin/visualfsharp
that referenced
this pull request
Feb 23, 2021
* Copy XmlDocuments to output directory * feedback
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.
This changes the xmldoc comments file for FSharp.Core into a nuget contentFile. Following this change, build and publish will deploy the FSharp.Core.xml doc comment file to the output directory, without the build author having to do any extra work.
I wish I was smarter than I actually am, because this 2 minute job took over a day. Good lord the contentFiles semantics are confusing.
Note: I have left the original FSharp.Core.xml in the lib directory, because when the package is referenced directly, which is a very common coreclr scenario it exists alongside the .dll. Also, any existing builds that included targets to copy the file to the output directory will still work. Although developers can ideally, remove those targets.