Skip to content

v0.12.0-preview0003

Pre-release
Pre-release
Compare
Choose a tag to compare
@dscbot dscbot released this 17 Jan 19:22
66a5f98

[v0.12.0-preview0003]

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.