Update New-AsBuiltReport parameter names to provide clarity of input requirements. Aliases used to prevent breaking changes.
OutputPath now an alias for OutputFolderPath
StylePath now an alias for StyleFilePath
ReportConfigPath now an alias for ReportConfigFilePath
AsBuiltConfigPath now an alias for AsBuiltConfigFilePath
Update New-AsBuiltReportConfig parameter names to provide clarity of input requirements. Aliases used to prevent breaking changes.
Path now an alias for FolderPath
Name now an alias for Filename
Update RequiredModules for PScribo 0.9.1
Custom style scripts are now executed from New-AsBuiltReport to allow use of new PScribo features
Add Filename parameter
Add error check for incorrect AsBuiltConfigFilePath
Improvements to verbose logging
Related Issue
Motivation and Context
Changes to parameter names are to provide clarity on the specific type of input required e.g. a folder or a file. Aliases have been added to parameters which have changed to prevent any breaking changes for previous implementations.
New filename parameter allows users to specify the filename they wish to set for their reports
Improvements to verbose logging to help with troubleshooting and debugging
How Has This Been Tested?
Changes have been tested against a number of different environments using a number of different scenarios. e.g. Testing with/without specific parameters
Screenshots (if appropriate):
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[X] My code follows the code style of this project.
[X] My change requires a change to the documentation.
Description
New-AsBuiltReport
parameter names to provide clarity of input requirements. Aliases used to prevent breaking changes.OutputPath
now an alias forOutputFolderPath
StylePath
now an alias forStyleFilePath
ReportConfigPath
now an alias forReportConfigFilePath
AsBuiltConfigPath
now an alias forAsBuiltConfigFilePath
New-AsBuiltReportConfig
parameter names to provide clarity of input requirements. Aliases used to prevent breaking changes.Path
now an alias forFolderPath
Name
now an alias forFilename
RequiredModules
for PScribo 0.9.1New-AsBuiltReport
to allow use of new PScribo featuresFilename
parameterAsBuiltConfigFilePath
Related Issue
Motivation and Context
Changes to parameter names are to provide clarity on the specific type of input required e.g. a folder or a file. Aliases have been added to parameters which have changed to prevent any breaking changes for previous implementations. New filename parameter allows users to specify the filename they wish to set for their reports Improvements to verbose logging to help with troubleshooting and debugging
How Has This Been Tested?
Changes have been tested against a number of different environments using a number of different scenarios. e.g. Testing with/without specific parameters
Screenshots (if appropriate):
Types of changes
Checklist: