Add tasks to generate markdown for public commands

[johlju]

Pull Request (PR) description

• Removed the public command Split-ModuleVersion since it is now available from the module Sampler.
• Task Generate_Markdown_For_Public_Commands - This task will generate markdown documentation for the public commands in the built module.
• Task Generate_External_Help_File_For_Public_Commands - This task will generate the modules help files to support Get-Help for public commands. This task is dependent on the task Generate_Markdown_For_Public_Commands to have been run prior.
• Task Clean_Markdown_Of_Public_Commands which will remove metadata and wrongly added parameters in the command markdown documentation.
• Private function Remove-MarkdownMetadataBlock that removes metadata from a Markdown file.
• Private function Remove-ParameterFromMarkdown that removes a parameter from a commands markdown documentation.
• Private function Remove-EscapedMarkdownCode that removes a escape sequences from the markdown documentation (that PlatyPS is making).
• Public command Edit-CommandDocumentation that will modify the a generated command markdown documentation.
• Public command Add-NewLine that can add line endings at the end of a file.
• DscResource.DocGenerator
  • Updated pipeline files to support resolving dependencies using ModuleFast or PSResourceGet.
  • Add blank line at top of each public command source file for PlatyPS to work. ModuleBuilder has no option to add a prefix per source file, the only alternative would be to move the comment-based help inside the function-block which is currently against the style guideline.
  • The built module is now removed from the session when initiating a new build. The build pipeline is dogfooding functionality and leaving a previous version imported in the session do not use new code.
• Get-CommentBasedHelp was fixed so it correctly filters out the comment-based help from a script file.

This Pull Request (PR) fixes the following issues

None.

Task list

• [x] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md. Entry should say what was changed and how that affects users (if applicable), and reference the issue being resolved (if applicable).
• [ ] Documentation added/updated in README.md.
• [ ] Comment-based help added/updated.
• [ ] Localization strings added/updated in all localization files as appropriate.
• [ ] Examples appropriately added/updated.
• [ ] Unit tests added/updated. See DSC Community Testing Guidelines.
• [ ] Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
• [x] New/changed code adheres to DSC Community Style Guidelines.

---

This change is 

[codecov[bot]]

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (74bc240) 97% compared to head (87b1ae1) 96%. Report is 1 commits behind head on main.

Additional details and impacted files

[](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) ```diff @@ Coverage Diff @@ ## main #133 +/- ## ==================================== - Coverage 97% 96% -2% ==================================== Files 42 52 +10 Lines 885 1015 +130 ==================================== + Hits 867 980 +113 - Misses 18 35 +17 ``` | [Files](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) | Coverage Δ | | |---|---|---| | [source/Private/Get-CommentBasedHelp.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvR2V0LUNvbW1lbnRCYXNlZEhlbHAucHMx) | `100% <100%> (ø)` | | | [source/Private/Remove-EscapedMarkdownCode.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvUmVtb3ZlLUVzY2FwZWRNYXJrZG93bkNvZGUucHMx) | `100% <100%> (ø)` | | | [source/Private/Remove-MarkdownMetadataBlock.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvUmVtb3ZlLU1hcmtkb3duTWV0YWRhdGFCbG9jay5wczE=) | `100% <100%> (ø)` | | | [source/Private/Remove-ParameterFromMarkdown.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvUmVtb3ZlLVBhcmFtZXRlckZyb21NYXJrZG93bi5wczE=) | `100% <100%> (ø)` | | | [...e/Task.Clean\_Markdown\_Of\_Public\_Commands.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGFzay5DbGVhbl9NYXJrZG93bl9PZl9QdWJsaWNfQ29tbWFuZHMuYnVpbGQucHMx) | `100% <100%> (ø)` | | | [...enerate\_External\_Help\_File\_For\_Public\_Commands.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGFzay5HZW5lcmF0ZV9FeHRlcm5hbF9IZWxwX0ZpbGVfRm9yX1B1YmxpY19Db21tYW5kcy5wczE=) | `100% <100%> (ø)` | | | [...sk.Generate\_Markdown\_For\_Public\_Commands.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGFzay5HZW5lcmF0ZV9NYXJrZG93bl9Gb3JfUHVibGljX0NvbW1hbmRzLmJ1aWxkLnBzMQ==) | `100% <100%> (ø)` | | | [source/Public/Add-NewLine.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9BZGQtTmV3TGluZS5wczE=) | `100% <100%> (ø)` | | | [source/Public/Edit-CommandDocumentation.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9FZGl0LUNvbW1hbmREb2N1bWVudGF0aW9uLnBzMQ==) | `100% <100%> (ø)` | | | [source/Public/Invoke-Git.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9JbnZva2UtR2l0LnBzMQ==) | `97% <ø> (ø)` | | | ... and [10 more](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/133?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) | |

[johlju]

I will merge this so that I can try this code on a bigger repo (SqlServerDsc). Any issues, I will fix.