v1.4.0

[tpcarman]

Description

Added

• Add AsBuiltReport default style script to resolve #44
• Add Core module version check and verbose reporting

Changed

• Improve bug and feature request templates
• Increase actions/checkout to v4
• Update MIT License copyright year
• Code cleanup to remove outdated code and comments
• Update heading styles in sample style scripts

Related Issue

Motivation and Context

This version provides an update to the AsBuiltReport Core module to use a default style rather than inidividual styles with each report module. This is to provide consistency with the look of generated reports as well as providing an easier method to update report formatting when necessary. Custom report styles are still supported, provided they follow the documented guidelines.

How Has This Been Tested?

• Tested in multiple lab and production environments

Screenshots (if appropriate):

Types of changes

• [X] Bug fix (non-breaking change which fixes an issue)
• [X] New feature (non-breaking change which adds functionality)
• [X] 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.
• [X] I have updated the documentation accordingly.
• [X] I have read the CONTRIBUTING page.

[github-actions[bot]]

PSScriptAnalyzer results:

Errors: [0], Warnings: [29], Information: [1]

``` RuleName : PSUseShouldProcessForStateChangingFunctions Severity : Warning ScriptName : New-AsBuiltReportConfig.ps1 Line : 1 Message : Function 'New-AsBuiltReportConfig' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 341 Message : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 342 Message : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 343 Message : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 393 Message : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 395 Message : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingPlainTextForPassword Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 141 Message : Parameter '$Password' should use SecureString, otherwise this will expose sensitive information. See ConvertTo-SecureString for more information. RuleName : PSUseShouldProcessForStateChangingFunctions Severity : Warning ScriptName : New-AsBuiltReport.ps1 Line : 1 Message : Function 'New-AsBuiltReport' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 29 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 30 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 31 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 44 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 45 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 46 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 74 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 75 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 76 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 150 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 151 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 152 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 207 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 208 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSAvoidUsingWriteHost Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 209 Message : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using Write-Host because it might not work in all hosts, does not work when there is no host, and (prior to PS 5.0) cannot be suppressed, captured, or redirected. Instead, use Write-Output, Write-Verbose, or Write-Information. RuleName : PSPossibleIncorrectComparisonWithNull Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 85 Message : $null should be on the left side of equality comparisons. RuleName : PSPossibleIncorrectComparisonWithNull Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 90 Message : $null should be on the left side of equality comparisons. RuleName : PSPossibleIncorrectComparisonWithNull Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 95 Message : $null should be on the left side of equality comparisons. RuleName : PSPossibleIncorrectComparisonWithNull Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 118 Message : $null should be on the left side of equality comparisons. RuleName : PSPossibleIncorrectComparisonWithNull Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 131 Message : $null should be on the left side of equality comparisons. RuleName : PSUseShouldProcessForStateChangingFunctions Severity : Warning ScriptName : New-AsBuiltConfig.ps1 Line : 1 Message : Function 'New-AsBuiltConfig' has verb that could change system state. Therefore, the function has to support 'ShouldProcess'. RuleName : PSUseOutputTypeCorrectly Severity : Information ScriptName : New-AsBuiltConfig.ps1 Line : 258 Message : The cmdlet 'New-AsBuiltConfig' returns an object of type 'System.Collections.Hashtable' but this type is not declared in the OutputType attribute. ```