Releases: dsccommunity/DscResource.DocGenerator
Releases · dsccommunity/DscResource.DocGenerator
v0.12.0-preview0001
[v0.12.0-preview0001]
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 supportGet-Help
for public commands.
This task is dependent on the taskGenerate_Markdown_For_Public_Commands
to have been run prior. - Task
Clean_Markdown_Of_Public_Commands
which will remove metadata and
wrongly added parameters in the command markdown documentation. - Private function
Remove-MarkdownMetadataBlock
that removes metadata from a
Markdown file. - 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. - Add blank line at top of each public command source file for PlatyPS
to work. ModuleBuilder has no option to add a prefix per source file,
the only alternative would be to move the comment-based help inside the
function-block which is currently against the style guideline. - 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.
- Updated pipeline files to support resolving dependencies using ModuleFast
Fixed
Get-CommentBasedHelp
was fixed so it correctly filters out the comment-based
help from a script file.
v0.11.2
v0.11.2-preview0001
[v0.11.2-preview0001]
Get-ClassResourceProperty
- Regression tests for PR #123.
- Now longer throws an exception if a parent class that isn't part of the
module is being used. If a class's source file is not found the class
is skipped (fixes issue #127).
v0.11.1
[v0.11.1]
Fixed
Get-ClassResourceProperty
- Now does a more limited wildcard search for the class script file (issue #122).
v0.11.1-preview0002
[v0.11.1-preview0002]
Fixed
Get-ClassResourceProperty
- Now does a more limited wildcard search for the class script file (issue #122).
v0.11.1-preview0001
[v0.11.1-preview0001]
v0.11.0
[v0.11.0]
Changed
- Updated pipelines files to the latest in Sampler.
- Fix missing verbose message in function
Invoke-Git
. - Fix variable reference for localized strings so they passed HQRM tests.
- Fix statement so function passed HQRM tests.
- Tasks now uses
Set-SamplerTaskVariable
from the module Sampler to set
the common build task variables. - Updated task parameters
ProjectName
andSourcePath
to reflect Sampler
Fixed
- Common task variables have not been set, fixed that.
Get-CompositeSchemaObject
threw an error when a composite did not have
comment based help, now returns$null
.
v0.11.0-preview0001
[v0.11.0-preview0001]
Changed
- Updated pipelines files to the latest in Sampler.
- Fix missing verbose message in function
Invoke-Git
. - Fix variable reference for localized strings so they passed HQRM tests.
- Fix statement so function passed HQRM tests.
- Tasks now uses
Set-SamplerTaskVariable
from the module Sampler to set
the common build task variables. - Updated task parameters
ProjectName
andSourcePath
to reflect Sampler
Fixed
- Common task variables have not been set, fixed that.
Get-CompositeSchemaObject
threw an error when a composite did not have
comment based help, now returns$null
.
v0.10.4-preview0002
[v0.10.4-preview0002]
Changed
- Updated pipelines files to the latest in Sampler.
- Fix missing verbose message in function
Invoke-Git
. - Fix variable reference for localized strings so they passed HQRM tests.
- Fix statement so function passed HQRM tests.
- Tasks now uses
Set-SamplerTaskVariable
from the module Sampler to set
the common build task variables.
v0.10.4-preview0001
[v0.10.4-preview0001]
Changed
- Updated pipelines files to the latest in Sampler.
- Fix missing verbose message in function
Invoke-Git
. - Fix variable reference for localized strings so they passed HQRM tests.
- Fix statement so function passed HQRM tests.