Releases: dsccommunity/DscResource.DocGenerator
Releases · dsccommunity/DscResource.DocGenerator
v0.6.0
[v0.6.0]
Added
- Added cmdlet
Publish-WikiContent
that publishes the Wiki content
generated by the cmdletNew-DscResourceWikiPage
. - Added build task
Publish_GitHub_Wiki_Content
that can publish content
to a GitHub Wiki repository. This task runs the cmdletPublish-WikiContent
. - Added a markdown page
Home.md
to the foldersource/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 taskPublish_GitHub_Wiki_Content
.
Removed
- The parameter
WikiSourcePath
was removed from the functionCopy-WikiFolder
. - The parameter
WikiSourcePath
was removed from the functionPublish-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 taskGenerate_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 toWikiSource
)
exists in the source folder then the content of that folder will be copied
to the Wiki output folder (defaults tooutput/WikiOutput
). If there is a
markdown file calledHome.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 taskGenerate_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
andGenerate_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
[v0.6.0-preview0002]
Added
- Added cmdlet
Publish-WikiContent
that publishes the Wiki content
generated by the cmdletNew-DscResourceWikiPage
. - Added build task
Publish_GitHub_Wiki_Content
that can publish content
to a GitHub Wiki repository. This task runs the cmdletPublish-WikiContent
. - Added a markdown page
Home.md
to the foldersource/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 taskPublish_GitHub_Wiki_Content
.
Removed
- The parameter
WikiSourcePath
was removed from the functionCopy-WikiFolder
. - The parameter
WikiSourcePath
was removed from the functionPublish-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 taskGenerate_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 toWikiSource
)
exists in the source folder then the content of that folder will be copied
to the Wiki output folder (defaults tooutput/WikiOutput
). If there is a
markdown file calledHome.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 taskGenerate_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
andGenerate_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
[v0.6.0-preview0001]
Added
- Added cmdlet
Publish-WikiContent
that publishes the Wiki content
generated by the cmdletNew-DscResourceWikiPage
. - Added build task
Publish_GitHub_Wiki_Content
that can publish content
to a GitHub Wiki repository. This task runs the cmdletPublish-WikiContent
. - Added a markdown page
Home.md
to the foldersource/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 taskPublish_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
andGenerate_Conceptual_Help
.
v0.5.2-preview0001
[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
v0.5.1-preview0001
[v0.5.1-preview0001]
Added
- Added helper function
Split-ModuleVersion
that is required by the helper
functionGet-BuiltModuleVersion
.
Changed
- Replaced the helper function
Get-ModuleVersion
with the helper function
Get-BuiltModuleVersion
.
v0.5.0
v0.5.0-preview0001
[v0.5.0-preview0001]
Fixed
- Fix missing documentation in the README.md for the cmdlet
New-DscResourceWikiPage
and the build taskGenerate_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
[v0.4.1-preview0001]
Fixed
- Fix missing documentation in the README.md for the cmdlet
New-DscResourceWikiPage
and the build taskGenerate_Wiki_Content
(issue #20).
v0.4.0
[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'sbuild.ps1
.
To make the task available forInvoke-Build
in a repository that is based
on Sampler add this module to
required modules, and then in thebuild.yaml
add the following.ModuleBuildTasks: DscResource.DocGenerator: - 'Task.*'