Merge pull request #117 from AsBuiltReport/dev

v1.3.4 Release Candidate 1
AsBuiltReport · Dec 1, 2023 · 5682b93 · 5682b93
2 parents 295420f + 43dfed5
commit 5682b93
Show file tree

Hide file tree

Showing 12 changed files with 351 additions and 201 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,98 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+assignees:
+  - tpcarman
+body:
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug description
+      description: >-
+        Please provide a clear and concise description of the bug.
+    validations:
+      required: true
+  - type: input
+    id: command-line-input
+    attributes:
+      label: Command-line input
+      description: >-
+        Please provide the command line input you are using to run AsBuiltReport. Please ensure that you obscure any sensitive information.
+      placeholder: New-AsBuiltReport -Report VMware.vSphere -Target xxxxxxx -Format Word,HTML -OutputFolderPath 'C:\Users\..\Documents' -AsBuiltConfigFilePath 'C:\Users\..\AsBuiltReport\AsBuiltReport.json' -ReportConfigFilePath 'C:\Users\..\AsBuiltReport\AsBuiltReport.VMware.vSphere.json' -EnableHealthCheck -Verbose
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: >-
+        Please provide a detailed list of steps to reproduce the bug.
+      placeholder: |-
+        1. ....
+        2. ....
+        3. ....
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Expected behaviour
+      description: >-
+        Please provide a clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: >-
+        Please attach any screenshots to help explain the problem.  Please ensure that you obscure any sensitive information.
+      placeholder: |-
+        Drag and drop screenshots here.
+  - type: textarea
+    id: operating-system
+    attributes:
+      label: Operating System
+      description: Please provide information about the operating system are you using.
+      placeholder: macOS Big Sur, Windows 10, Ubuntu 20.04 LTS
+    validations:
+      required: true
+  - type: textarea
+    id: powershell-version
+    attributes:
+      label: PowerShell Version
+      description: Please provide information about the PowerShell version you are using. Please provide the output from the following PowerShell command `$PSVersionTable`.
+      placeholder: $PSVersionTable
+    validations:
+      required: true
+  - type: textarea
+    id: powershell-modules
+    attributes:
+      label: PowerShell Modules
+      description: Please provide information about the PowerShell modules are you using. Please provide the output from the following PowerShell command `Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.vSphere";"PSPKI";"PScriboCharts";"PScribo") | Select Name, Version`
+      placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.vSphere";"PScribo") | Select Name, Version
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: This field is optional. You may provide additional context for the bug you wish to report. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues) or other relevant information.
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Before submitting
+      description: >-
+        Please ensure your bug report fulfills all of the following requirements.
+        If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
+      options:
+        - label: >-
+            I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
+          required: true
+        - label: >-
+            I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
+            and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
+          required: true
+        - label: >-
+            I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues) before submitting this bug report.
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/change_request.yml b/.github/ISSUE_TEMPLATE/change_request.yml
@@ -0,0 +1,34 @@
+name: Change Request
+description: Request a new change or an improvement
+labels: ["change request"]
+assignees:
+  - tpcarman
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: >-
+        Please provide a detailed description of your idea so that the project maintainers and contributors can fully understand what change, feature, or improvement you are proposing.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: This field is optional. You may provide additional context for the idea you wish to propose. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues) or other relevant information.
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Before submitting
+      description: >-
+        Please ensure your change request fulfills all of the following requirements.
+        If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
+      options:
+        - label: >-
+            I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
+            and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this change request.
+          required: true
+        - label: >-
+            I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues) before submitting this change request.
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   publish-to-gallery:
-    runs-on: ubuntu-latest
+    runs-on: windows-2019
     steps:
       - uses: actions/checkout@v2
       - name: Set PSRepository to Trusted for PowerShell Gallery
@@ -17,11 +17,16 @@ jobs:
         shell: pwsh
         run: |
           Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
+      - name: Test Module Manifest
+        shell: pwsh
+        run: |
+          Test-ModuleManifest .\AsBuiltReport.VMware.vSphere.psd1
       - name: Publish module to PowerShell Gallery
         shell: pwsh
         run: |
           Publish-Module -Path ./ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose
   tweet:
+    needs: publish-to-gallery
     runs-on: ubuntu-latest
     steps:
       - uses: Eomm/why-don-t-you-tweet@v1

diff --git a/AsBuiltReport.VMware.vSphere.Style.ps1 b/AsBuiltReport.VMware.vSphere.Style.ps1
@@ -11,14 +11,15 @@ Style -Name 'Heading 1' -Size 16 -Color '00364D'
 Style -Name 'Heading 2' -Size 14 -Color '004B6B'
 Style -Name 'Heading 3' -Size 12 -Color '00567A'
 Style -Name 'Heading 4' -Size 11 -Color '00648F'
+Style -Name 'NO TOC Heading 4' -Size 11 -Color '00648F'
 Style -Name 'Heading 5' -Size 10 -Color '0072A3'
+Style -Name 'NO TOC Heading 5' -Size 10 -Color '0072A3'
 Style -Name 'Normal' -Size 10 -Color '565656' -Default
 Style -Name 'Caption' -Size 10 -Color '565656' -Italic -Align Center
 Style -Name 'Header' -Size 10 -Color '565656' -Align Center
 Style -Name 'Footer' -Size 10 -Color '565656' -Align Center
 Style -Name 'TOC' -Size 16 -Color '00364D'
-#Style -Name 'TableDefaultHeading' -Size 10 -Color '565656' -BackgroundColor 'FAFAFA' # Light Theme
-Style -Name 'TableDefaultHeading' -Size 10 -Color 'FAFAFA' -BackgroundColor '00364D' # Dark Theme
+Style -Name 'TableDefaultHeading' -Size 10 -Color 'FAFAFA' -BackgroundColor '00364D'
 Style -Name 'TableDefaultRow' -Size 10 -Color '565656'
 Style -Name 'Critical' -Size 10 -Color '565656' -BackgroundColor 'FEDDD7'
 Style -Name 'Warning' -Size 10 -Color '565656' -BackgroundColor 'FFF4C7'
@@ -30,8 +31,7 @@ $TableDefaultProperties = @{
     Id = 'TableDefault'
     HeaderStyle = 'TableDefaultHeading'
     RowStyle = 'TableDefaultRow'
-    #BorderColor = 'A6A6A6' # Light Theme
-    BorderColor = '00364D' # Dark Theme
+    BorderColor = '00364D'
     Align = 'Left'
     CaptionStyle = 'Caption'
     CaptionLocation = 'Below'

diff --git a/AsBuiltReport.VMware.vSphere.psd1 b/AsBuiltReport.VMware.vSphere.psd1
@@ -12,7 +12,7 @@
     RootModule = 'AsBuiltReport.VMware.vSphere.psm1'
 
     # Version number of this module.
-    ModuleVersion = '1.3.3.1'
+    ModuleVersion = '1.3.4'
 
     # Supported PSEditions
     # CompatiblePSEditions = 'Desktop'
@@ -105,13 +105,13 @@
             ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere'
 
             # A URL to an icon representing this module.
-            IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
+            IconUri = ' https://github.com/AsBuiltReport.png'
 
             # ReleaseNotes of this module
             ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/master/CHANGELOG.md'
 
             # Prerelease string of this module
-            # Prerelease = ''
+            Prerelease = 'rc1'
 
             # Flag to indicate whether the module requires explicit user acceptance for install/update/save
             # RequireLicenseAcceptance = $false

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,22 @@
 # :arrows_clockwise: VMware vSphere As Built Report Changelog
 
+## [[1.3.4-RC1](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/releases/tag/v1.3.4-RC1)] - 2023-12-01
+
+### Changed
+- Updated VMware PowerCLI requirements to version 13.2 ([Fix #107](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/107))
+- Improved bug and feature request templates (@rebelinux)
+- Improved TOC structure
+- Updated VMware style script for improved TOC structure
+
+### Fixed
+- Updated VMHost PCI Devices reporting to fix issues with ESXi 8.x hosts (@orb71) ([Fix #105](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/105)) & ([Fix #111](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/111))
+- Added Try/Catch stated PCI Drivers and Firmware section to provide a workaround for ESXi 8.x hosts ([Fix #116](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/116))
+- Updated vCenter Server alarms reporting ([Fix #106](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/106))
+- Fixed issue with Platform Services Controller reporting ([Fix #103](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/issues/103))
+
+### Removed
+- Removed reporting of vCenter Server OS type
+
 ## [[1.3.3.1](https://github.com/AsBuiltReport/AsBuiltReport.VMware.vSphere/releases/tag/v1.3.3.1)] - 2022-04-21
 
 ### Added