Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Integrate Set-DescriptionFromReadme #85

Closed
majkinetor opened this issue Jun 27, 2017 · 6 comments
Closed

Integrate Set-DescriptionFromReadme #85

majkinetor opened this issue Jun 27, 2017 · 6 comments

Comments

@majkinetor
Copy link
Owner

No description provided.

@AdmiringWorm
Copy link
Contributor

If this is added, it should probably be added in a way that automatically escapes specific characters into their xml/http variant(actually easily done by using InnerText property I believe), or by wrapping <description> inside a <![CDATA tag

@majkinetor
Copy link
Owner Author

Definitely, I was bitten by this number of times.

@majkinetor
Copy link
Owner Author

majkinetor commented Sep 19, 2017

That actually is harder then it seems because markdown can contain some html directives so any escape there would render them invalid.

So CDATA will be used

@majkinetor
Copy link
Owner Author

This is implemented in automatic_readme branch and I will merge it when I see how it works on my repo.

I opted for this to be totally automatic by default - if Readme.md is present it will be used unless you specify NoReadme to update.

@AdmiringWorm
Copy link
Contributor

That actually is harder then it seems because markdown can contain some html directives so any escape there would render them invalid.

Not really that hard, I actually use a helper in my own repository which escapes the necessary invalid xml without much code at all:
https://github.com/AdmiringWorm/chocolatey-packages/blob/master/scripts/Update-Metadata.ps1

This is implemented in automatic_readme branch and I will merge it when I see how it works on my repo.

awesome

@majkinetor
Copy link
Owner Author

majkinetor commented Sep 20, 2017

I added README.md's to few most frequently updated tools on coreteam repo so we can check out how it works ASAP.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants