v0.12.4

[v0.12.4]

Fixed

• Generate_Markdown_For_Public_Commands.build
  • Now the task will skip if PlatyPS is not available.
    Generate_External_Help_File_For_Public_Commands
  • Now the task will skip if PlatyPS is not available.

v0.12.4-preview0001

[v0.12.4-preview0001]

Fixed

• Generate_Markdown_For_Public_Commands.build
  • Now the task will skip if PlatyPS is not available.
    Generate_External_Help_File_For_Public_Commands
  • Now the task will skip if PlatyPS is not available.

v0.12.3

[v0.12.3]

Fixed

• Generate_Markdown_For_Public_Commands.build
  • Now the task will not try to generate markdown if the module does not
    have any publicly exported commands (issue #135).
  • Now has error handling if the script that is called using the call
    operator & fails.
    Generate_External_Help_File_For_Public_Commands
  • Now the task will not fail if there are no extern help file generated,
    which is the case for modules that does not have any publicly exported
    commands (issue #135).
  • Now has error handling if the script that is called using the call
    operator & fails.

v0.12.3-preview0001

[v0.12.3-preview0001]

Fixed

• Generate_Markdown_For_Public_Commands.build
  • Now the task will not try to generate markdown if the module does not
    have any publicly exported commands (issue #135).
  • Now has error handling if the script that is called using the call
    operator & fails.
    Generate_External_Help_File_For_Public_Commands
  • Now the task will not fail if there are no extern help file generated,
    which is the case for modules that does not have any publicly exported
    commands (issue #135).
  • Now has error handling if the script that is called using the call
    operator & fails.

v0.12.2

[v0.12.2]

Added

• Task Package_Wiki_Content - This task will compress generated documentation
  into a .zip archive.

Changed

• Skipped failing tests on Linux due to libmi.
• Task Generate_Wiki_Content converted to a metatask. Existing
  functionality split into smaller tasks. Fixes (Issue #135)

v0.12.2-preview0002

[v0.12.2-preview0002]

Added

• Task Package_Wiki_Content - This task will compress generated documentation
  into a .zip archive.

Changed

• Skipped failing tests on Linux due to libmi.
• Task Generate_Wiki_Content converted to a metatask. Existing
  functionality split into smaller tasks. Fixes (Issue #135)

v0.12.2-preview0001

[v0.12.2-preview0001]

Added

• Task Package_Wiki_Content - This task will compress generated documentation
  into a .zip archive.

Changed

• Skipped failing tests on Linux due to libmi.

v0.12.1

[v0.12.1]

Fixed

• Remove-EscapedMarkdownCode
  • Add additional escape sequences to remove (issue #140).

v0.12.1-preview0001

[v0.12.1-preview0001]

Fixed

• Remove-EscapedMarkdownCode
  • Add additional escape sequences to remove (issue #140).

v0.12.0

[v0.12.0]

Removed

• Removed the public command Split-ModuleVersion since it is now available
  from the module Sampler.

Added

• 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 edit the the command
  markdown documentation. For example it will remove the ProgressAction
  parameter that PlatyPS remove wrongly add (due to a bug).
• Task Clean_Markdown_Metadata which will remove the markdown metadata
  block from the markdown documentation. The metadata block was used for
  other tasks to know what type of content the markdown file contained.
• Task Generate_Wiki_Sidebar - This task will generate the GitHub Wiki
  Repository sidebar based on the files present in the built documentation
  folder (defaults to ./output/WikiOutput).
• Public command Remove-MarkdownMetadataBlock that removes metadata from a
  Markdown file.
• Public command New-GitHubWikiSidebar generate the GitHub Wiki
  Repository sidebar based on the files present in the built documentation
  folder (defaults to ./output/WikiOutput).
• 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.

Changed

• DscResource.DocGenerator
  • Updated pipeline files to support resolving dependencies using ModuleFast
    or PSResourceGet.
  • 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.
• Task Generate_Wiki_Content
  • Support passing metadata trough the build configuration file (build.yaml).
• New-DscResourceWikiPage
  • A new parameter Metadata that takes a hashtable of metadata. See
    comment-based help for the format of the hashtable.
• New-DscClassResourceWikiPage
  • A new parameter Metadata that takes a hashtable of metadata. See
    comment-based help for the format of the hashtable.
• New-DscCompositeResourceWikiPage
  • A new parameter Metadata that takes a hashtable of metadata. See
    comment-based help for the format of the hashtable.
• New-DscMofResourceWikiPage
  • A new parameter Metadata that takes a hashtable of metadata. See
    comment-based help for the format of the hashtable.

Fixed

• Get-CommentBasedHelp was fixed so it correctly filters out the comment-based
  help from a script file.
• Remove-MarkdownMetadataBlock was fixed to only remove the metadata block
  at the top of the file.