GH3517: Add NuGet Pack ReadMe Support#3518
GH3517: Add NuGet Pack ReadMe Support#3518devlead wants to merge 1 commit intocake-build:developfrom
Conversation
devlead
force-pushed
the
feature/gh-3517
branch
from
32e9be8 to
6b22fc7
Compare
augustoproiete
left a comment
augustoproiete
left a comment
There was a problem hiding this comment.
Added a couple of comments. Am I missing any docs convention that is documented somewhere?
| public bool OutputToToolFolder { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets Path to markdown Markdown (.md) file containing package readme packed into docs folder. |
There was a problem hiding this comment.
| /// Gets or sets Path to markdown Markdown (.md) file containing package readme packed into docs folder. | |
| /// Gets or sets Path to markdown Markdown (.md) file containing package readme. |
AFAIK there's no requirement for the README to be in a docs folder - it can be anywhere in the package. Most of the examples I see have the README.md file at the root of the package
| { "tags", x => ToSpaceSeparatedString(settings.Tags) }, | ||
| { "serviceable", x => ToString(settings.Serviceable) } | ||
| { "serviceable", x => ToString(settings.Serviceable) }, | ||
| { "readme", x => settings.ReadMePath is { } readme ? string.Concat("docs\\", readme.GetFilename().FullPath) : null }, |
There was a problem hiding this comment.
| { "readme", x => settings.ReadMePath is { } readme ? string.Concat("docs\\", readme.GetFilename().FullPath) : null }, | |
| { "readme", x => settings.ReadMePath is { } readme ? readme.GetFilename().FullPath : null }, |
Same as above: AFAIK there's no requirement for the README to be in a docs folder - it can be anywhere in the package. Most of the examples I see have the README.md file at the root of the package
| { | ||
| var fileElement = document.CreateAndAppendElement(filesElement, "file"); | ||
| fileElement.AddAttributeIfSpecified(settings.ReadMePath.FullPath, "src"); | ||
| fileElement.AddAttributeIfSpecified("docs", "target"); |
There was a problem hiding this comment.
Same as above: AFAIK there's no requirement for the README to be in a docs folder - it can be anywhere in the package. Most of the examples I see have the README.md file at the root of the package
|
|
||
| if (hasReadMe) | ||
| { | ||
| var fileElement = document.CreateAndAppendElement(filesElement, "file"); |
There was a problem hiding this comment.
I haven't actually run this to test, but I'm under the impression the README could already be present in the list of files - wouldn't this duplicate the entry in the nuspec?
2 participants
Fixes #3517