DscResource.DocGenerator

Author(s)

• DSC Community

Tags

DSC Modules documentation

Functions

Invoke-Git New-DscResourcePowerShellHelp New-DscResourceWikiPage Publish-WikiContent Set-WikiModuleVersion Split-ModuleVersion

Dependencies

This module has no dependencies.

Release Notes

## [0.9.0-preview0011] - 2021-07-08

### Added

- Added private functions:
 - `Get-ClassAst` - Returns the AST for a single or all classes.
 - `Get-ClassResourceAst` - Returns the AST for a single or all DSC class
   resources.
 - `Get-ClassResourceProperty` - Returns DSC class resource properties
   from the provided class or classes.
 - `Format-Text` - Format a string according to predefined options.
 - `Get-TemporaryPath` - returns the appropriate temp path for the OS.
 - `Get-ConfigurationAst` - Returns the AST for a single or all configurations.
 - `Get-CompositeSchemaObject` - Returns an object containing the parameters
   and other properties related to a composite resource. The object that is
   returned is different format to a MOF or class-based object and the property
   names are aligned to a configuration parameter block rather than MOF.
 - `Get-CompositeResourceParameterState` - Determines the parameter state of a
   composite resource parameter. This is a meta attribute that will either be
   `Required` or `Write`.
 - `Get-CompositeResourceParameterValidateSet` - Returns the array of values
   contained in the ValidateSet parameter attributes if it exists.
- Added QA test to do some quality checks on the module code and change log.

### Changed

- `New-DscResourceWikiPage`
 - If a class-based resource has a parent class that contains DSC resource
   properties they will now also be returned as part of the DSC resource
   parameters ([issue #62](https://github.com/dsccommunity/DscResource.DocGenerator/issues/62)).
 - Refactored to split into two private functions `New-DscMofResourceWikiPage` and
   `New-DscClassResourceWikiPage`.
- `Get-MofSchemaObject`
 - Refactored to reduce code duplication when adding functions for supporting
   composite resources.
- `Get-ClassResourceCommentBasedHelp`
 - Renamed this function to `Get-CommentBasedHelp` so that it made sense to
   use with composite DSC resources.
 - Enabled the function to extract the comment block if it is not at the top
   of the script file to support composite resources.
- Updated code to pass newly added quality checks.
- `Invoke-Git`
 - Converted to public function.
 - Updated to use `System.Diagnostics.Process` for improved error handling.
 - Returns object, allowing caller to process result.
 - `git` commands no longer use `--quiet` to populate returned object.

### Fixed

- `Publish_GitHub_Wiki_Content`
 - Output message if `$GitHubToken` not specified which skips this task.
   Fixes [Issue 75](https://github.com/dsccommunity/DscResource.DocGenerator/issues/75)
 - Change working folder for the call to `git` with the argument `remote`.
 - Added optional debug configuration option in `build.yml`.
- `Invoke-Git`
 - Set `$TimeOut` to Milliseconds
   Fixes [Issue 84](https://github.com/dsccommunity/DscResource.DocGenerator/issues/84)
 - Calls `git` so it works on both Windows and Linux.
 - Output properties in return value if called with the `Debug` optional
   common parameter.
- `Publish-WikiContent`
 - Remove a unnecessary `Set-Location` so it is possible to remove the
   temporary folder.
 - Fix code style in tests.
 - Moved verbose statement so it is only outputted in the right context.