Fix Nuke highly oppinionated XML and MD helper to our own code #125
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
Contributor
Arkatufus
commented
Oct 4, 2022
Arkatufus
commented
- Add our own markdown "parser"
- Insert a CDATA section into the XML if the input has '<' or '>' instead of sanitizing the text.
Arkatufus
commented
Oct 4, 2022
| } | ||
| } | ||
|
|
||
| private static IEnumerable<ReleaseSection> GetReleaseSections(List<string> content) |
There was a problem hiding this comment.
This method is replaced.
Instead of adhering to the draconian keep a changelog rule, we instead grab anything between the H2 headers as changelog content.
Arkatufus
commented
Oct 4, 2022
| /// <param name="changelogFile">The path to the changelog file.</param> | ||
| /// <returns>A <see cref="ChangeLog"/> object to work with the changelog.</returns> | ||
| [Pure] | ||
| public static ChangeLog ReadChangelog(string changelogFile) |
There was a problem hiding this comment.
Copied over from Nuke, no change
Arkatufus
commented
Oct 4, 2022
| /// <param name="tag">The tag which release notes should get extracted.</param> | ||
| /// <returns>A collection of the release notes.</returns> | ||
| [Pure] | ||
| public static IEnumerable<string> ExtractChangelogSectionNotes(string changelogFile, string tag = null) |
There was a problem hiding this comment.
Copied over from Nuke, no change
Arkatufus
commented
Oct 4, 2022
|
|
||
| public static class MdHelper | ||
| { | ||
| public static string GetNuGetReleaseNotes(string changelogFile, GitRepository repository = null) |
There was a problem hiding this comment.
Copied over from Nuke, no change
Arkatufus
commented
Oct 4, 2022
| /// <param name="changelogFile">The path to the changelog file.</param> | ||
| /// <returns>A readonly list of the release sections contained in the changelog.</returns> | ||
| [Pure] | ||
| public static IReadOnlyList<ReleaseNotes> ReadReleaseNotes(string changelogFile) |
There was a problem hiding this comment.
Copied over from Nuke, no change
Arkatufus
commented
Oct 4, 2022
| var (elements, attributes) = GetObjects(document, xpath, namespaces); | ||
| Assert.True((elements.Count == 1 || attributes.Count == 1) && !(elements.Count == 0 && attributes.Count == 0)); | ||
|
|
||
| if (value.Contains('<') || value.Contains('>')) |
There was a problem hiding this comment.
If the input string have invalid XML text, wrap it inside a CDATA block
Arkatufus
commented
Oct 4, 2022
| document.Save(xmlWriter); | ||
| } | ||
|
|
||
| private static (IReadOnlyCollection<XElement> Elements, IReadOnlyCollection<XAttribute> Attributes) GetObjects( |
There was a problem hiding this comment.
Copied over from Nuke, no change
Aaronontheweb
approved these changes
Oct 4, 2022
| } | ||
| } | ||
|
|
||
| private static IEnumerable<ReleaseSection> GetReleaseSections(List<string> content) |
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.