v0.13.0-preview0004

[v0.13.0-preview0004]

Removed

• Removed build.psd1 as it is no longer required to build the project.
• Removed ClassAst functions
  • Get-ClassResourceProperty
  • Get-ClassAst
  • Get-ClassResourceAst

Added

• Added a devcontainer for development.
• Added private function ConvertTo-WikiSidebarLinkName that converts a
  name to a format suitable for use as a Wiki sidebar link.
• New tasks:
  • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare
    the markdown file names for publishing to the GitHub Wiki by replacing
    hyphens with spaces and converting Unicode hyphens to standard hyphens.
    It can be controlled by parameter ReplaceHyphen in the task, which
    defaults to $true.
  • Clean_WikiContent_For_GitHub_Publish - This task will remove the top
    level header from any markdown file where the top level header equals the
    filename. The task will convert standard hyphens to spaces and Unicode
    hyphens to standard hyphens before comparison. The task can be controlled
    by parameter RemoveTopLevelHeader in the task, which defaults to $true.
• Added Helper functions as part of [#163] (#163).
  • Get-ClassPropertyCustomAttribute
  • Get-DscResourceAttributeProperty
  • Get-DscPropertyType
  • Test-ClassPropertyDscAttributeArgument

Changed

• New-GitHubWikiSidebar
  • Replaces ASCII hyphens for the Wiki sidebar.
  • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
• Task Generate_Wiki_Content
  • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the
    markdown files and external help file for command help has been generated.
  • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to
    remove the top level header from any markdown file where the top level
    header equals the filename.
• Task Generate_Markdown_For_Public_Commands
  • Verbose output of the markdown files that was created.
• Task Generate_Markdown_For_DSC_Resources
  • Outputs a warning message if the old configuration key is used in the
    build configuration but keeps using the old configuration key.
• New-DscClassResourcePage
  • Remove using Ast to generate documentation. Fixes #116.
  • Order properties correctly fixes #126.

Fixed

• Fix Dockerfile to include GitVersion alias for PowerShell Extension profile script.
• Fix .vscode/settings.json file to exclude unrecognized words.

v0.13.0-preview0003

[v0.13.0-preview0003]

Removed

• Removed build.psd1 as it is no longer required to build the project.

Added

• Added a devcontainer for development.
• Added private function ConvertTo-WikiSidebarLinkName that converts a
  name to a format suitable for use as a Wiki sidebar link.
• New tasks:
  • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare
    the markdown file names for publishing to the GitHub Wiki by replacing
    hyphens with spaces and converting Unicode hyphens to standard hyphens.
    It can be controlled by parameter ReplaceHyphen in the task, which
    defaults to $true.
  • Clean_WikiContent_For_GitHub_Publish - This task will remove the top
    level header from any markdown file where the top level header equals the
    filename. The task will convert standard hyphens to spaces and Unicode
    hyphens to standard hyphens before comparison. The task can be controlled
    by parameter RemoveTopLevelHeader in the task, which defaults to $true.

Changed

• New-GitHubWikiSidebar
  • Replaces ASCII hyphens for the Wiki sidebar.
  • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
• Task Generate_Wiki_Content
  • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the
    markdown files and external help file for command help has been generated.
  • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to
    remove the top level header from any markdown file where the top level
    header equals the filename.
• Task Generate_Markdown_For_Public_Commands
  • Verbose output of the markdown files that was created.
• Task Generate_Markdown_For_DSC_Resources
  • Outputs a warning message if the old configuration key is used in the
    build configuration but keeps using the old configuration key.

Fixed

• Fix Dockerfile to include GitVersion alias for PowerShell Extension profile script.
• Fix .vscode/settings.json file to exclude unrecognized words.

v0.13.0-preview0002

[v0.13.0-preview0002]

Removed

• Removed build.psd1 as it is no longer required to build the project.

Added

• Added a devcontainer for development.
• Added private function ConvertTo-WikiSidebarLinkName that converts a
  name to a format suitable for use as a Wiki sidebar link.
• New tasks:
  • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare
    the markdown file names for publishing to the GitHub Wiki by replacing
    hyphens with spaces and converting Unicode hyphens to standard hyphens.
    It can be controlled by parameter ReplaceHyphen in the task, which
    defaults to $true.
  • Clean_WikiContent_For_GitHub_Publish - This task will remove the top
    level header from any markdown file where the top level header equals the
    filename (converting Unicode hyphen to ASCII hyphen before comparison).
    It can be controlled by parameter RemoveTopLevelHeader in the task, which
    defaults to $true.

Changed

• New-GitHubWikiSidebar
  • Replaces ASCII hyphens for the Wiki sidebar.
  • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
• Task Generate_Wiki_Content
  • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the
    markdown files and external help file for command help has been generated.
  • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to
    remove the top level header from any markdown file where the top level
    header equals the filename.
• Task Generate_Markdown_For_Public_Commands
  • Verbose output of the markdown files that was created.
• Task Generate_Markdown_For_DSC_Resources
  • Outputs a warning message if the old configuration key is used in the
    build configuration but keeps using the old configuration key.

Fixed

• Fix Dockerfile to include GitVersion alias for PowerShell Extension profile script.
• Fix .vscode/settings.json file to exclude unrecognized words.

v0.13.0-preview0001

[v0.13.0-preview0001]

Removed

• Removed build.psd1 as it is no longer required to build the project.

Added

• Added a devcontainer for development.
• Added private function ConvertTo-WikiSidebarLinkName that converts a
  name to a format suitable for use as a Wiki sidebar link.
• New tasks:
  • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare
    the markdown file names for publishing to the GitHub Wiki by replacing
    hyphens with spaces and converting Unicode hyphens to standard hyphens.
    It can be controlled by parameter ReplaceHyphen in the task, which
    defaults to $true.
  • Clean_WikiContent_For_GitHub_Publish - This task will remove the top
    level header from any markdown file where the top level header equals the
    filename (converting Unicode hyphen to ASCII hyphen before comparison).
    It can be controlled by parameter RemoveTopLevelHeader in the task, which
    defaults to $true.

Changed

• New-GitHubWikiSidebar
  • Replaces ASCII hyphens for the Wiki sidebar.
  • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
• Task Generate_Wiki_Content
  • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the
    markdown files and external help file for command help has been generated.
  • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to
    remove the top level header from any markdown file where the top level
    header equals the filename.
• Task Generate_Markdown_For_Public_Commands
  • Verbose output of the markdown files that was created.

Fixed

• Fix Dockerfile to include GitVersion alias for PowerShell Extension profile script.
• Fix .vscode/settings.json file to exclude unrecognized words.

v0.12.5

[v0.12.5]

• Get-ClassResourceProperty
  • Check for a prefixed and non-prefixed class names issue #132.
• azure-pipelines
  • Pin gitversion to V5.
• Update README with the tasks that were not documented.
• Generate_Wiki_Content
  • Change the order of the tasks to avoid getting and exception when
    source/WikiSource contain additional markdown files that are copied
    to output/WikiContent.

v0.12.5-preview0002

[v0.12.5-preview0002]

• Get-ClassResourceProperty
  • Check for a prefixed and non-prefixed class names issue #132.
• azure-pipelines
  • Pin gitversion to V5.
• Update README with the tasks that were not documented.
• Generate_Wiki_Content
  • Change the order of the tasks to avoid getting and exception when
    source/WikiSource contain additional markdown files that are copied
    to output/WikiContent.

v0.12.5-preview0001

[v0.12.5-preview0001]

• Get-ClassResourceProperty
  • Check for a prefixed and non-prefixed class names issue #132.
• azure-pipelines
  • Pin gitversion to V5.

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.