This change addresses the initial phase of #25 in that it converts the New-AsBuiltReport.ps1 into an advanced function and refactors the project into a module. I have also updated the New-AsBuiltReport.ps1 help contents and the main project README.md to reflect this change.
Related Issue
25
Motivation and Context
This change has been discussed with the team and is generally accepted as the correct way forward. It allows us to provide the standardised PowerShell command style that users are used to using. It also allows us to start investigating hosting the project on the PSGallery for easier installation.
How Has This Been Tested?
I have tested this re factored module against my test environments and no issues were found when generating multiple reports.
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[] 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.
Description
This change addresses the initial phase of #25 in that it converts the
New-AsBuiltReport.ps1
into an advanced function and refactors the project into a module. I have also updated theNew-AsBuiltReport.ps1
help contents and the main projectREADME.md
to reflect this change.Related Issue
25
Motivation and Context
This change has been discussed with the team and is generally accepted as the correct way forward. It allows us to provide the standardised PowerShell command style that users are used to using. It also allows us to start investigating hosting the project on the PSGallery for easier installation.
How Has This Been Tested?
I have tested this re factored module against my test environments and no issues were found when generating multiple reports.
Types of changes
Checklist: