From c0cf6e4b85287b1db83bf49997117d4a6ca2d341 Mon Sep 17 00:00:00 2001 From: Tim Carman Date: Wed, 18 Feb 2026 12:15:52 +1100 Subject: [PATCH 1/5] Update Bug Report template --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f7632d0..321f3fd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,6 +4,15 @@ labels: ["bug"] assignees: - tpcarman body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report :) + - Kindly **DO NOT** ask for instructions. + - Use [Discussions](https://github.com/orgs/AsBuiltReport/discussions) section if you have a query or doubts or any other relevant question. + - Read project's [Web Site](https://www.asbuiltreport.com/user-guide/quickstart/) for detailed documentation. + - Read project's [FAQs](https://www.asbuiltreport.com/support/faq/) section for Frequently asked questions. + - Search for previous [Issues](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues)/[Pull Requests](https://github.com/AsBuiltReport/AsBuiltReport.Core/pulls) if this issue is already reported or fix has been created. - type: textarea id: bug-description attributes: From d6f47868c91e377e77fdac8b1551aec49b4d9683 Mon Sep 17 00:00:00 2001 From: Tim Carman Date: Wed, 18 Feb 2026 12:41:35 +1100 Subject: [PATCH 2/5] Add JSON output format support --- AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 | 8 ++++---- CHANGELOG.md | 6 ++++++ README.md | 4 ++-- TESTING.md | 2 +- Tests/AsBuiltReport.Core.Tests.ps1 | 3 ++- Tests/Unit/New-AsBuiltReport.Tests.ps1 | 3 ++- 6 files changed, 17 insertions(+), 9 deletions(-) diff --git a/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 b/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 index 295e5b6..7b41e9a 100644 --- a/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 +++ b/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 @@ -1,9 +1,9 @@ function New-AsBuiltReport { <# .SYNOPSIS - Documents the configuration of IT infrastructure in Word/HTML/Text formats using PScribo. + Documents the configuration of IT infrastructure in Word/HTML/Text/JSON formats using PScribo. .DESCRIPTION - Documents the configuration of IT infrastructure in Word/HTML/Text formats using PScribo. + Documents the configuration of IT infrastructure in Word/HTML/Text/JSON formats using PScribo. .PARAMETER Report Specifies the type of report that will be generated. .PARAMETER Target @@ -26,7 +26,7 @@ function New-AsBuiltReport { This parameter has an alias 'MFA' for backwards compatibility. .PARAMETER Format Specifies the output format of the report. - The supported output formats are WORD, HTML & TEXT. + The supported output formats are WORD, HTML, TEXT & JSON. Multiple output formats may be specified, separated by a comma. .PARAMETER ReportLanguage Specifies the language for report content generated by the report module. @@ -234,7 +234,7 @@ function New-AsBuiltReport { HelpMessage = 'Please provide the document output format' )] [ValidateNotNullOrEmpty()] - [ValidateSet('Word', 'HTML', 'Text')] + [ValidateSet('Word', 'HTML', 'Text', 'JSON')] [Array] $Format = 'Word', [Parameter( diff --git a/CHANGELOG.md b/CHANGELOG.md index d9dc15d..dd0afb8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.7.0] - Unreleased + +### Added +- Add `JSON` output format support + + ## [1.6.1] - 2026-02-09 ### Added diff --git a/README.md b/README.md index 6531b66..316dcee 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ _Note: You are not limited to installing the module to those example paths, you ### **New-AsBuiltReport** -The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of AsBuiltReport to generate is specified by using the `Report` parameter. The report parameter relies on additional report modules being installed alongside the `AsBuiltReport.Core` module. The `Target` parameter specifies one or more systems on which to connect and run the report. User credentials to the system are specified using the `Credential`, or the `Username` and `Password` parameters. One or more document formats, such as `HTML`, `Word` or `Text` can be specified using the `Format` parameter. Additional parameters are outlined below. +The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of AsBuiltReport to generate is specified by using the `Report` parameter. The report parameter relies on additional report modules being installed alongside the `AsBuiltReport.Core` module. The `Target` parameter specifies one or more systems on which to connect and run the report. User credentials to the system are specified using the `Credential`, or the `Username` and `Password` parameters. One or more document formats, such as `HTML`, `Word`, `Text` or `JSON` can be specified using the `Format` parameter. Additional parameters are outlined below. ```powershell .PARAMETER Report @@ -191,7 +191,7 @@ The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of A This parameter has an alias 'MFA' for backwards compatibility. .PARAMETER Format Specifies the output format of the report. - The supported output formats are WORD, HTML & TEXT. + The supported output formats are WORD, HTML, TEXT & JSON. Multiple output formats may be specified, separated by a comma. .PARAMETER ReportLanguage Specifies the language for report content generated by the report module. diff --git a/TESTING.md b/TESTING.md index 7d7392d..81c623b 100644 --- a/TESTING.md +++ b/TESTING.md @@ -88,7 +88,7 @@ Tests individual functions in isolation: - ✓ Parameter validation and types - ✓ Parameter aliases (Target/Server/IP, etc.) - ✓ Multiple parameter sets (Credential, Token, InteractiveAuth) -- ✓ Format validation (Word, HTML, Text) +- ✓ Format validation (Word, HTML, Text, JSON) - ✓ Orientation validation (Portrait, Landscape) - ✓ Help documentation completeness - ✓ Argument completers diff --git a/Tests/AsBuiltReport.Core.Tests.ps1 b/Tests/AsBuiltReport.Core.Tests.ps1 index 6b5c837..f51522d 100644 --- a/Tests/AsBuiltReport.Core.Tests.ps1 +++ b/Tests/AsBuiltReport.Core.Tests.ps1 @@ -147,12 +147,13 @@ Describe 'AsBuiltReport.Core Module Tests' { $NewAsBuiltReportCommand.Parameters.Keys | Should -Contain 'Credential' } - It 'New-AsBuiltReport Format parameter should accept Word, HTML, and Text' { + It 'New-AsBuiltReport Format parameter should accept Word, HTML, Text, and JSON' { $FormatParam = $NewAsBuiltReportCommand.Parameters['Format'] $ValidateSetAttribute = $FormatParam.Attributes | Where-Object { $_ -is [System.Management.Automation.ValidateSetAttribute] } $ValidateSetAttribute.ValidValues | Should -Contain 'Word' $ValidateSetAttribute.ValidValues | Should -Contain 'HTML' $ValidateSetAttribute.ValidValues | Should -Contain 'Text' + $ValidateSetAttribute.ValidValues | Should -Contain 'JSON' } It 'New-AsBuiltReportConfig should have Report parameter' { diff --git a/Tests/Unit/New-AsBuiltReport.Tests.ps1 b/Tests/Unit/New-AsBuiltReport.Tests.ps1 index f682664..2e10d42 100644 --- a/Tests/Unit/New-AsBuiltReport.Tests.ps1 +++ b/Tests/Unit/New-AsBuiltReport.Tests.ps1 @@ -65,12 +65,13 @@ Describe 'New-AsBuiltReport Unit Tests' { $FormatParam | Should -Not -BeNullOrEmpty } - It 'Format parameter should accept Word, HTML, and Text' { + It 'Format parameter should accept Word, HTML, Text, and JSON' { $FormatParam = $Command.Parameters['Format'] $ValidateSetAttribute = $FormatParam.Attributes | Where-Object { $_ -is [System.Management.Automation.ValidateSetAttribute] } $ValidateSetAttribute.ValidValues | Should -Contain 'Word' $ValidateSetAttribute.ValidValues | Should -Contain 'HTML' $ValidateSetAttribute.ValidValues | Should -Contain 'Text' + $ValidateSetAttribute.ValidValues | Should -Contain 'JSON' } It 'Orientation parameter should accept Portrait and Landscape' { From 1c8339c9d65f868d3e90e1d49f0b6fc03e700c47 Mon Sep 17 00:00:00 2001 From: Tim Carman Date: Wed, 18 Feb 2026 14:37:54 +1100 Subject: [PATCH 3/5] Revert "Add JSON output format support" This reverts commit d6f47868c91e377e77fdac8b1551aec49b4d9683. --- AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 | 8 ++++---- CHANGELOG.md | 6 ------ README.md | 4 ++-- TESTING.md | 2 +- Tests/AsBuiltReport.Core.Tests.ps1 | 3 +-- Tests/Unit/New-AsBuiltReport.Tests.ps1 | 3 +-- 6 files changed, 9 insertions(+), 17 deletions(-) diff --git a/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 b/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 index 7b41e9a..295e5b6 100644 --- a/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 +++ b/AsBuiltReport.Core/Src/Public/New-AsBuiltReport.ps1 @@ -1,9 +1,9 @@ function New-AsBuiltReport { <# .SYNOPSIS - Documents the configuration of IT infrastructure in Word/HTML/Text/JSON formats using PScribo. + Documents the configuration of IT infrastructure in Word/HTML/Text formats using PScribo. .DESCRIPTION - Documents the configuration of IT infrastructure in Word/HTML/Text/JSON formats using PScribo. + Documents the configuration of IT infrastructure in Word/HTML/Text formats using PScribo. .PARAMETER Report Specifies the type of report that will be generated. .PARAMETER Target @@ -26,7 +26,7 @@ function New-AsBuiltReport { This parameter has an alias 'MFA' for backwards compatibility. .PARAMETER Format Specifies the output format of the report. - The supported output formats are WORD, HTML, TEXT & JSON. + The supported output formats are WORD, HTML & TEXT. Multiple output formats may be specified, separated by a comma. .PARAMETER ReportLanguage Specifies the language for report content generated by the report module. @@ -234,7 +234,7 @@ function New-AsBuiltReport { HelpMessage = 'Please provide the document output format' )] [ValidateNotNullOrEmpty()] - [ValidateSet('Word', 'HTML', 'Text', 'JSON')] + [ValidateSet('Word', 'HTML', 'Text')] [Array] $Format = 'Word', [Parameter( diff --git a/CHANGELOG.md b/CHANGELOG.md index dd0afb8..d9dc15d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,12 +6,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [1.7.0] - Unreleased - -### Added -- Add `JSON` output format support - - ## [1.6.1] - 2026-02-09 ### Added diff --git a/README.md b/README.md index 316dcee..6531b66 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ _Note: You are not limited to installing the module to those example paths, you ### **New-AsBuiltReport** -The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of AsBuiltReport to generate is specified by using the `Report` parameter. The report parameter relies on additional report modules being installed alongside the `AsBuiltReport.Core` module. The `Target` parameter specifies one or more systems on which to connect and run the report. User credentials to the system are specified using the `Credential`, or the `Username` and `Password` parameters. One or more document formats, such as `HTML`, `Word`, `Text` or `JSON` can be specified using the `Format` parameter. Additional parameters are outlined below. +The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of AsBuiltReport to generate is specified by using the `Report` parameter. The report parameter relies on additional report modules being installed alongside the `AsBuiltReport.Core` module. The `Target` parameter specifies one or more systems on which to connect and run the report. User credentials to the system are specified using the `Credential`, or the `Username` and `Password` parameters. One or more document formats, such as `HTML`, `Word` or `Text` can be specified using the `Format` parameter. Additional parameters are outlined below. ```powershell .PARAMETER Report @@ -191,7 +191,7 @@ The `New-AsBuiltReport` cmdlet is used to generate AsBuiltReports. The type of A This parameter has an alias 'MFA' for backwards compatibility. .PARAMETER Format Specifies the output format of the report. - The supported output formats are WORD, HTML, TEXT & JSON. + The supported output formats are WORD, HTML & TEXT. Multiple output formats may be specified, separated by a comma. .PARAMETER ReportLanguage Specifies the language for report content generated by the report module. diff --git a/TESTING.md b/TESTING.md index 81c623b..7d7392d 100644 --- a/TESTING.md +++ b/TESTING.md @@ -88,7 +88,7 @@ Tests individual functions in isolation: - ✓ Parameter validation and types - ✓ Parameter aliases (Target/Server/IP, etc.) - ✓ Multiple parameter sets (Credential, Token, InteractiveAuth) -- ✓ Format validation (Word, HTML, Text, JSON) +- ✓ Format validation (Word, HTML, Text) - ✓ Orientation validation (Portrait, Landscape) - ✓ Help documentation completeness - ✓ Argument completers diff --git a/Tests/AsBuiltReport.Core.Tests.ps1 b/Tests/AsBuiltReport.Core.Tests.ps1 index f51522d..6b5c837 100644 --- a/Tests/AsBuiltReport.Core.Tests.ps1 +++ b/Tests/AsBuiltReport.Core.Tests.ps1 @@ -147,13 +147,12 @@ Describe 'AsBuiltReport.Core Module Tests' { $NewAsBuiltReportCommand.Parameters.Keys | Should -Contain 'Credential' } - It 'New-AsBuiltReport Format parameter should accept Word, HTML, Text, and JSON' { + It 'New-AsBuiltReport Format parameter should accept Word, HTML, and Text' { $FormatParam = $NewAsBuiltReportCommand.Parameters['Format'] $ValidateSetAttribute = $FormatParam.Attributes | Where-Object { $_ -is [System.Management.Automation.ValidateSetAttribute] } $ValidateSetAttribute.ValidValues | Should -Contain 'Word' $ValidateSetAttribute.ValidValues | Should -Contain 'HTML' $ValidateSetAttribute.ValidValues | Should -Contain 'Text' - $ValidateSetAttribute.ValidValues | Should -Contain 'JSON' } It 'New-AsBuiltReportConfig should have Report parameter' { diff --git a/Tests/Unit/New-AsBuiltReport.Tests.ps1 b/Tests/Unit/New-AsBuiltReport.Tests.ps1 index 2e10d42..f682664 100644 --- a/Tests/Unit/New-AsBuiltReport.Tests.ps1 +++ b/Tests/Unit/New-AsBuiltReport.Tests.ps1 @@ -65,13 +65,12 @@ Describe 'New-AsBuiltReport Unit Tests' { $FormatParam | Should -Not -BeNullOrEmpty } - It 'Format parameter should accept Word, HTML, Text, and JSON' { + It 'Format parameter should accept Word, HTML, and Text' { $FormatParam = $Command.Parameters['Format'] $ValidateSetAttribute = $FormatParam.Attributes | Where-Object { $_ -is [System.Management.Automation.ValidateSetAttribute] } $ValidateSetAttribute.ValidValues | Should -Contain 'Word' $ValidateSetAttribute.ValidValues | Should -Contain 'HTML' $ValidateSetAttribute.ValidValues | Should -Contain 'Text' - $ValidateSetAttribute.ValidValues | Should -Contain 'JSON' } It 'Orientation parameter should accept Portrait and Landscape' { From 8ada8de9f83d1db6973555504f6f14685ed9380e Mon Sep 17 00:00:00 2001 From: Tim Carman Date: Thu, 19 Feb 2026 07:39:05 +1100 Subject: [PATCH 4/5] v1.6.2 release ### Fixed - Fix issue with module manifest which prevented dependent modules from being installed --- AsBuiltReport.Core/AsBuiltReport.Core.psd1 | 5 +---- CHANGELOG.md | 4 ++++ 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/AsBuiltReport.Core/AsBuiltReport.Core.psd1 b/AsBuiltReport.Core/AsBuiltReport.Core.psd1 index 5e0b0c0..44ca2d3 100644 --- a/AsBuiltReport.Core/AsBuiltReport.Core.psd1 +++ b/AsBuiltReport.Core/AsBuiltReport.Core.psd1 @@ -13,7 +13,7 @@ # Version number of this module. - ModuleVersion = '1.6.1' + ModuleVersion = '1.6.2' # Supported PSEditions CompatiblePSEditions = @('Desktop', 'Core') @@ -121,9 +121,6 @@ # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false - # External dependent modules of this module - ExternalModuleDependencies = @('PScribo') - } # End of PSData hashtable } # End of PrivateData hashtable diff --git a/CHANGELOG.md b/CHANGELOG.md index d9dc15d..8249cd6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.6.2] - 2026-02-19 + +### Fixed +- Fix issue with module manifest which prevented dependent modules from being installed ## [1.6.1] - 2026-02-09 From 0028544e9d1b74315e3a8f5ce8fbc53a3413659d Mon Sep 17 00:00:00 2001 From: Tim Carman Date: Thu, 19 Feb 2026 07:43:11 +1100 Subject: [PATCH 5/5] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8249cd6..12a9fae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [1.6.2] - 2026-02-19 +### Changed +- Update bug report template + ### Fixed - Fix issue with module manifest which prevented dependent modules from being installed