Merge pull request #182 from AsBuiltReport/dev

v0.8.2 public release
AsBuiltReport · Jun 15, 2024 · 7d46025 · 7d46025
2 parents e96cede + b77de48
commit 7d46025
Show file tree

Hide file tree

Showing 29 changed files with 2,410 additions and 976 deletions.
diff --git a/.github/workflows/PSScriptAnalyzerSettings.psd1 b/.github/workflows/PSScriptAnalyzerSettings.psd1
@@ -1,10 +1,17 @@
 @{
     ExcludeRules = @(
         'PSUseBOMForUnicodeEncodedFile',
-        'PSUseToExportFieldsInManifest',
-        'PSReviewUnusedParameter',
-        'PSUseDeclaredVarsMoreThanAssignments',
-        'PSAvoidGlobalVars',
-        'PSAvoidUsingEmptyCatchBlock'
+        'PSUseToExportFieldsInManifest'
     )
+    Rules = @{
+        PSAvoidExclaimOperator = @{
+            Enable = $true
+        }
+        AvoidUsingDoubleQuotesForConstantString = @{
+            Enable = $true
+        }
+        UseCorrectCasing = @{
+            Enable = $true
+        }
+    }
 }
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -25,6 +25,10 @@ jobs:
         shell: pwsh
         run: |
           Install-Module -Name PScriboCharts -Repository PSGallery -Force
+      - name: Install Diagrammer.Core module
+        shell: pwsh
+        run: |
+          Install-Module -Name Diagrammer.Core -Repository PSGallery -Force
       - name: Install Diagrammer.Microsoft.AD module
         shell: pwsh
         run: |
@@ -41,7 +45,7 @@ jobs:
     needs: publish-to-gallery
     runs-on: ubuntu-latest
     steps:
-      - uses: Eomm/why-don-t-you-tweet@v1
+      - uses: Eomm/why-don-t-you-tweet@v2
         # We don't want to tweet if the repository is not a public one
         if: ${{ !github.event.repository.private }}
         with:

diff --git a/AsBuiltReport.Microsoft.AD.Style.ps1 b/AsBuiltReport.Microsoft.AD.Style.ps1
@@ -62,7 +62,7 @@ if ($ReportConfig.Report.ShowHeaderFooter) {
 }
 
 # Set position of report titles and information based on page orientation
-if (!($ReportConfig.Report.ShowCoverPageImage)) {
+if (-Not ($ReportConfig.Report.ShowCoverPageImage)) {
     $LineCount = 5
 }
 if ($Orientation -eq 'Portrait') {

diff --git a/AsBuiltReport.Microsoft.AD.json b/AsBuiltReport.Microsoft.AD.json
@@ -21,9 +21,9 @@
     },
     "InfoLevel": {
         "_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed",
-        "Forest": 1,
-        "Domain": 1,
-        "DNS": 0,
+        "Forest": 2,
+        "Domain": 2,
+        "DNS": 1,
         "CA": 0
     },
     "HealthCheck": {

diff --git a/AsBuiltReport.Microsoft.AD.psd1 b/AsBuiltReport.Microsoft.AD.psd1
@@ -12,7 +12,7 @@
     RootModule = 'AsBuiltReport.Microsoft.AD.psm1'
 
     # Version number of this module.
-    ModuleVersion = '0.8.1'
+    ModuleVersion = '0.8.2'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -67,7 +67,12 @@
         @{
             ModuleName = 'Diagrammer.Microsoft.AD';
             ModuleVersion = '0.2.3'
+        },
+        @{
+            ModuleName = 'Diagrammer.Core';
+            ModuleVersion = '0.2.1'
         }
+
     )
 
     # Assemblies that must be loaded prior to importing this module

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,30 @@ 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.0.0/).
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.2] - 2024-06-15
+
+### Added
+
+- Add Diagrammer.Core to the module RequiredModules list
+
+### Changed
+
+- Improve the code to better handle errors
+- Update the Eomm/why-don-t-you-tweet action to v2.0.0
+- Increase the default InfoLevel for the Forest and Domain section (InfoLevel 2)
+- Enable DNS section by default (InfoLevel 1)
+
+### Fixed
+
+- Fix [#160](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/160)
+- Fix [#168](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/168)
+- Fix [#171](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/171)
+- Fix [#172](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/172)
+- Fix [#174](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/174)
+- Fix [#176](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/176)
+- Fix [#178](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/178)
+- Fix [#180](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.AD/issues/180)
+
 ## [0.8.1] - 2024-05-16
 
 ### Added

diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@
 
 Microsoft AD As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core).
 
-[AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilises PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
+[AsBuiltReport](https://github.com/AsBuiltReport/AsBuiltReport) is an open-sourced community project which utilizes PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies.
 
 Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for more detailed information about this project.
 
@@ -178,20 +178,22 @@ The **InfoLevel** schema allows configuration of each section of the report at a
 
 There are 4 levels (0-3) of detail granularity for each section as follows;
 
-| Setting | InfoLevel   | Description                                                          |
-| :-----: | ----------- | -------------------------------------------------------------------- |
-|    0    | Disabled    | Does not collect or display any information                          |
-|    1    | Enabled     | Provides summarised information for a collection of objects          |
-|    2    | Adv Summary | Provides condensed, detailed information for a collection of objects |
-|    3    | Detailed    | Provides detailed information for individual objects                 |
+| Setting | InfoLevel    | Description                                                                                         |
+| :-----: | ------------ | --------------------------------------------------------------------------------------------------- |
+|    0    | Disabled     | Does not collect or display any information                                                         |
+|    1    | Enabled      | Provides summarized information for a collection of objects                                         |
+|    2    | Adv Summary  | Provides condensed, detailed information for a collection of objects                                |
+|    3    | Detailed     | Provides detailed information for individual objects                                                |
+|    4    | Adv Detailed | Provides detailed information for individual objects, as well as information for associated objects |
+
 
 The table below outlines the default and maximum **InfoLevel** settings for each section.
 
 | Sub-Schema | Default Setting | Maximum Setting |
 | ---------- | :-------------: | :-------------: |
-| Forest     |        1        |        1        |
-| Domain     |        1        |        3        |
-| DNS        |        0        |        2        |
+| Forest     |        2        |        1        |
+| Domain     |        2        |        4        |
+| DNS        |        1        |        2        |
 | CA         |        0        |        3        |
 
 ### Healthcheck
@@ -228,3 +230,5 @@ PS C:\> New-AsBuiltReport -Report Microsoft.AD -Target 'admin-dc-01v.contoso.loc
 - In some cases when trying to update the report, an error similar to this is generated:
   - "PackageManagement\Install-Package : Authenticode issuer 'CN="xyz, INC.", O="xyz, INC.", L=San Jose, S=California on the previusly-installed module 'PSPKI'. If you still want to install or update, use -SkipPublisherCheck parameter."
   - The expected workaround is to add the '-SkipPublisherCheck' to the install module 'Update-Module -Name PSPKI -Force -SkipPublisherCheck'
+- Issues when running the report against Windows Server 2012 and 2012 R2.
+  - Error: "Exception calling Save with 1 argument(s): hexadecimal value 0x00, is an invalid character."