Skip to content

Releases: dsccommunity/DscResource.DocGenerator

v0.6.0

22 Jun 19:59
bdb890d
Compare
Choose a tag to compare

[v0.6.0]

Added

  • Added cmdlet Publish-WikiContent that publishes the Wiki content
    generated by the cmdlet New-DscResourceWikiPage.
  • Added build task Publish_GitHub_Wiki_Content that can publish content
    to a GitHub Wiki repository. This task runs the cmdlet Publish-WikiContent.
  • Added a markdown page Home.md to the folder source/WikiSource that
    will be published to the GitHub Wiki for each PR that is merged. The
    module version number will be updated prior to pushing to the Wiki.
    This is done by the the build task Publish_GitHub_Wiki_Content.

Removed

  • The parameter WikiSourcePath was removed from the function Copy-WikiFolder.
  • The parameter WikiSourcePath was removed from the function Publish-WikiContent.
  • The parameter WikiSourceFolderName was removed from the build task
    Publish_GitHub_Wiki_Content.
  • The function Publish-WikiContent will no longer call the function
    Set-WikiModuleVersion (it is now done by the task Generate_Wiki_Content).

Changed

  • Update the documentation style in the README.md.
  • The repository is using the latest version of the module ModuleBuilder.
  • The repository was pinned to use version 4.10.1 of the module Pester
    since this repository does not support Pester 5 tests yet.
  • Updated build.ps1 to be able to dogfood build tasks.
  • Moved the Wiki source logic from Publish-WikiContent to the build task
    Generate_Wiki_Content to align with the other tasks that creates a
    build artifact that should be deployed. Publish-WikiContent no longer
    changes the build artifact during publishing. The build task
    Generate_Wiki_Content now first generates documentation for any existing
    DSC resources. Secondly if the Wiki source folder (defaults to WikiSource)
    exists in the source folder then the content of that folder will be copied
    to the Wiki output folder (defaults to output/WikiOutput). If there is a
    markdown file called Home.md then any module version placeholders (#.#.#)
    will be replaced by the built module version.
  • The Set-WikiModuleVersion was made a public function to be able to
    use it in the build task Generate_Wiki_Content.

Fixed

  • Fixed issue with New-DscResourceWikiPage where Test-Path was case sensitive
    on Linux machines and therefore didn't find some Readme.md files.
  • Minor style and documentation updates to the build tasks Generate_Wiki_Content
    and Generate_Conceptual_Help.
  • Fixed example in comment-based help form cmdlet New-DscResourceWikiPage.
  • Fixed a problem in the build task Publish_GitHub_Wiki_Content that
    made the Wiki output path to not shown correctly.

v0.6.0-preview0002

22 Jun 19:18
bdb890d
Compare
Choose a tag to compare
v0.6.0-preview0002 Pre-release
Pre-release

[v0.6.0-preview0002]

Added

  • Added cmdlet Publish-WikiContent that publishes the Wiki content
    generated by the cmdlet New-DscResourceWikiPage.
  • Added build task Publish_GitHub_Wiki_Content that can publish content
    to a GitHub Wiki repository. This task runs the cmdlet Publish-WikiContent.
  • Added a markdown page Home.md to the folder source/WikiSource that
    will be published to the GitHub Wiki for each PR that is merged. The
    module version number will be updated prior to pushing to the Wiki.
    This is done by the the build task Publish_GitHub_Wiki_Content.

Removed

  • The parameter WikiSourcePath was removed from the function Copy-WikiFolder.
  • The parameter WikiSourcePath was removed from the function Publish-WikiContent.
  • The parameter WikiSourceFolderName was removed from the build task
    Publish_GitHub_Wiki_Content.
  • The function Publish-WikiContent will no longer call the function
    Set-WikiModuleVersion (it is now done by the task Generate_Wiki_Content).

Changed

  • Update the documentation style in the README.md.
  • The repository is using the latest version of the module ModuleBuilder.
  • The repository was pinned to use version 4.10.1 of the module Pester
    since this repository does not support Pester 5 tests yet.
  • Updated build.ps1 to be able to dogfood build tasks.
  • Moved the Wiki source logic from Publish-WikiContent to the build task
    Generate_Wiki_Content to align with the other tasks that creates a
    build artifact that should be deployed. Publish-WikiContent no longer
    changes the build artifact during publishing. The build task
    Generate_Wiki_Content now first generates documentation for any existing
    DSC resources. Secondly if the Wiki source folder (defaults to WikiSource)
    exists in the source folder then the content of that folder will be copied
    to the Wiki output folder (defaults to output/WikiOutput). If there is a
    markdown file called Home.md then any module version placeholders (#.#.#)
    will be replaced by the built module version.
  • The Set-WikiModuleVersion was made a public function to be able to
    use it in the build task Generate_Wiki_Content.

Fixed

  • Fixed issue with New-DscResourceWikiPage where Test-Path was case sensitive
    on Linux machines and therefore didn't find some Readme.md files.
  • Minor style and documentation updates to the build tasks Generate_Wiki_Content
    and Generate_Conceptual_Help.
  • Fixed example in comment-based help form cmdlet New-DscResourceWikiPage.
  • Fixed a problem in the build task Publish_GitHub_Wiki_Content that
    made the Wiki output path to not shown correctly.

v0.6.0-preview0001

20 Jun 22:27
46044a6
Compare
Choose a tag to compare
v0.6.0-preview0001 Pre-release
Pre-release

[v0.6.0-preview0001]

Added

  • Added cmdlet Publish-WikiContent that publishes the Wiki content
    generated by the cmdlet New-DscResourceWikiPage.
  • Added build task Publish_GitHub_Wiki_Content that can publish content
    to a GitHub Wiki repository. This task runs the cmdlet Publish-WikiContent.
  • Added a markdown page Home.md to the folder source/WikiSource that
    will be published to the GitHub Wiki for each PR that is merged. The
    module version number will be updated prior to pushing to the Wiki.
    This is done by the the build task Publish_GitHub_Wiki_Content.

Changed

  • Update the documentation style in the README.md.
  • The repository is using the latest version of the module ModuleBuilder.
  • The repository was pinned to use version 4.10.1 of the module Pester
    since this repository does not support Pester 5 tests yet.
  • Updated build.ps1 to be able to dogfood build tasks.

Fixed

  • Fixed issue with New-DscResourceWikiPage where Test-Path was case sensitive
    on Linux machines and therefore didn't find some Readme.md files.
  • Minor style and documentation updates to the build tasks Generate_Wiki_Content
    and Generate_Conceptual_Help.

v0.5.2-preview0001

16 Jun 22:14
d289c8b
Compare
Choose a tag to compare
v0.5.2-preview0001 Pre-release
Pre-release

[v0.5.2-preview0001]

Fixed

  • Fixed issue with New-DscResourceWikiPage where Test-Path was case sensitive
    on Linux machines and therefore didn't find some Readme.md files.

v0.5.1

01 May 12:12
6321893
Compare
Choose a tag to compare

[v0.5.1]

Added

  • Added helper function Split-ModuleVersion that is required by the helper
    function Get-BuiltModuleVersion.

Changed

  • Replaced the helper function Get-ModuleVersion with the helper function
    Get-BuiltModuleVersion.

v0.5.1-preview0001

01 May 12:04
6321893
Compare
Choose a tag to compare
v0.5.1-preview0001 Pre-release
Pre-release

[v0.5.1-preview0001]

Added

  • Added helper function Split-ModuleVersion that is required by the helper
    function Get-BuiltModuleVersion.

Changed

  • Replaced the helper function Get-ModuleVersion with the helper function
    Get-BuiltModuleVersion.

v0.5.0

28 Mar 04:48
20480b9
Compare
Choose a tag to compare

[v0.5.0]

Fixed

  • Fix missing documentation in the README.md for the cmdlet New-DscResourceWikiPage
    and the build task Generate_Wiki_Content (issue #20).
  • The function Get-MofSchemaObject did not correctly create the temporary
    schema file depending on the formatting of the schema.

v0.5.0-preview0001

27 Mar 23:39
20480b9
Compare
Choose a tag to compare
v0.5.0-preview0001 Pre-release
Pre-release

[v0.5.0-preview0001]

Fixed

  • Fix missing documentation in the README.md for the cmdlet New-DscResourceWikiPage
    and the build task Generate_Wiki_Content (issue #20).
  • The function Get-MofSchemaObject did not correctly create the temporary
    schema file depending on the formatting of the schema.

v0.4.1-preview0001

26 Feb 17:54
e161d60
Compare
Choose a tag to compare
v0.4.1-preview0001 Pre-release
Pre-release

[v0.4.1-preview0001]

Fixed

  • Fix missing documentation in the README.md for the cmdlet New-DscResourceWikiPage
    and the build task Generate_Wiki_Content (issue #20).

v0.4.0

25 Feb 20:47
66548b7
Compare
Choose a tag to compare

[v0.4.0]

Added

  • Added build tasks Generate_Wiki_Content (that runs the cmdlet
    New-DscResourceWikiPage). The build task is primarily meant to be run by
    the project Sampler's build.ps1.
    To make the task available for Invoke-Build in a repository that is based
    on Sampler add this module to
    required modules, and then in the build.yaml add the following.
    ModuleBuildTasks:
      DscResource.DocGenerator:
        - 'Task.*'

Fixed

  • Fixes the build task Generate_Conceptual_Help to use the correct
    module version folder name for the built module path (issue #17).
  • Fixes the build task Generate_Conceptual_Help to correctly evaluate
    the module version (issue #21).