Merge pull request #51 from AsBuiltReport/dev

tpcarman · web-flow · commit 8d13542e8013 · 2024-03-29T13:58:27.000+11:00
v1.4.0
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 ReportType -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.Vendor.Technology.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";"PScribo") | Select Name, Version`
+      placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"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.Core/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/support/known-issues/) before submitting this bug report.
+          required: true
+        - label: >-
+            I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.Core/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.Core/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/support/known-issues/) before submitting this change request.
+          required: true
+        - label: >-
+            I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.Core/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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -31,4 +31,4 @@
 - [ ] My code follows the code style of this project.
 - [ ] My change requires a change to the documentation.
 - [ ] I have updated the documentation accordingly.
-- [ ] I have read the [**CONTRIBUTING**](/CONTRIBUTING.md) page.
+- [ ] I have read the [**CONTRIBUTING**](https://www.asbuiltreport.com/about/contributing/) page.
diff --git a/.github/workflows/PSScriptAnalyzer.yml b/.github/workflows/PSScriptAnalyzer.yml
@@ -5,7 +5,7 @@ jobs:
     name: Run PSScriptAnalyzer
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: lint
       uses: devblackops/github-action-psscriptanalyzer@master
       with:
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -8,7 +8,7 @@ jobs:
   publish-to-gallery:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |
diff --git a/AsBuiltReport.Core.Style.ps1 b/AsBuiltReport.Core.Style.ps1
diff --git a/AsBuiltReport.Core.psd1 b/AsBuiltReport.Core.psd1
@@ -13,7 +13,7 @@
 
     # Version number of this module.
 
-    ModuleVersion = '1.3.0'
+    ModuleVersion = '1.4.0'
 
     # Supported PSEditions
     # CompatiblePSEditions = 'Desktop'
@@ -28,7 +28,7 @@
     # CompanyName = ''
 
     # Copyright statement for this module
-    Copyright = '(c) 2022 Tim Carman. All rights reserved.'
+    Copyright = '(c) 2024 Tim Carman. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description = 'A PowerShell module which provides the core framework for generating As-Built documentation for many common datacentre systems.'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,30 @@
 # :arrows_clockwise: AsBuiltReport.Core Changelog
 
+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.4.0] - 2024-03-29
+
+### Added
+
+- Add AsBuiltReport default style script to resolve [#44](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues/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
+
+### Fixed
+
+- Fix ReadMe AsBuiltReport logo URL
+- Fix [#45](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues/45)
+
 ## [1.3.0] - 2022-10-22
 
 ### Added
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 AsBuiltReport
+Copyright (c) 2024 AsBuiltReport
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <p align="center">
     <a href="https://www.asbuiltreport.com/" alt="AsBuiltReport"></a>
-            <img src='https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png' width="8%" height="8%" /></a>
+            <img src='https://avatars.githubusercontent.com/u/42958564' width="8%" height="8%" /></a>
 </p>
 <p align="center">
     <a href="https://www.powershellgallery.com/packages/AsBuiltReport.Core/" alt="PowerShell Gallery Version">
@@ -39,8 +39,8 @@ The following simple list of instructions will get you started with the AsBuiltR
 ### **PowerShell**
 This module is compatible with the following PowerShell versions;
 
-| Windows PowerShell 5.1 | PowerShell 7 |
-|:----------------------:|:------------------:|
+| Windows PowerShell 5.1 |    PowerShell 7    |
+| :--------------------: | :----------------: |
 |   :white_check_mark:   | :white_check_mark: |
 
 ## :wrench: System Requirements
@@ -49,9 +49,9 @@ The following PowerShell module will be automatically installed by following the
 
 This PowerShell module may also be manually installed via the PowerShell Gallery or GitHub.
 
-| Module Name        | Minimum Required Version |                          PS Gallery                           |                                   GitHub                                    |
-|--------------------|:------------------------:|:---------------------------------------------------------------------:|:---------------------------------------------------------------------------:|
-| PScribo            |          0.10.0           |      [Link](https://www.powershellgallery.com/packages/PScribo)       |         [Link](https://github.com/iainbrighton/PScribo/tree/master)
+| Module Name | Minimum Required Version |                         PS Gallery                         |                           GitHub                            |
+| ----------- | :----------------------: | :--------------------------------------------------------: | :---------------------------------------------------------: |
+| PScribo     |          0.10.0          | [Link](https://www.powershellgallery.com/packages/PScribo) | [Link](https://github.com/iainbrighton/PScribo/tree/master) |
 
 To find a list of available report modules, run the following PowerShell command;
 
@@ -121,7 +121,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 as built reports. The type of as built report 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 specifed 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 as built reports. The type of as built report 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
@@ -166,8 +166,8 @@ The `New-AsBuiltReport` cmdlet is used to generate as built reports. The type of
     run, with the option to save the configuration to a file.
 .PARAMETER ReportConfigFilePath
     Enter the full path to a report JSON configuration file.
-    If this parameter is not specified, a default report configuration JSON is copied to the specifed user folder.
-    If this paramter is specified and the path to a JSON file is invalid, the script will terminate
+    If this parameter is not specified, a default report configuration JSON is copied to the specified user folder.
+    If this parameter is specified and the path to a JSON file is invalid, the script will terminate
 ```
 
 For a full list of common parameters and examples you can view the `New-AsBuiltReport` cmdlet help with the following command;
@@ -223,7 +223,7 @@ New-AsBuiltReport -Report 'Nutanix.PrismElement' -Target 'prism.nutanix.local' -
 $Credentials = Get-Credential
 New-AsBuiltReport -Report 'PureStorage.FlashArray' -Target '192.168.1.100' -Credential $Credentials -Format Text -Timestamp -OutputFolderPath 'H:\Documents\'
 
-# The following creates a Cisco UCS Manager As Built report in default format (Word) with a customised style.
+# The following creates a Cisco UCS Manager As Built report in default format (Word) with a customized style.
 New-AsBuiltReport -Report 'Cisco.UCSManager' -Target '192.168.1.100' -Username 'admin' -Password 'admin' -StyleFilePath 'C:\scripts\ACME.ps1' -OutputFolderPath 'H:\Documents\'
 
 # The following creates a Nutanix Prism Element As Built report in HTML format, with a custom filename.
diff --git a/Samples/AsBuiltReport.Sample.Style-1.ps1 b/Samples/AsBuiltReport.Sample.Style-1.ps1
@@ -14,7 +14,12 @@ Style -Name 'Heading 1' -Size 16 -Color 'F30E0D'
 Style -Name 'Heading 2' -Size 14 -Color '223F8C'
 Style -Name 'Heading 3' -Size 12 -Color 'FDDA00'
 Style -Name 'Heading 4' -Size 11 -Color '6BADE6'
+Style -Name 'NO TOC Heading 4' -Size 11 -Color '6BADE6'
 Style -Name 'Heading 5' -Size 10 -Color '6BADE6'
+Style -Name 'NO TOC Heading 5' -Size 10 -Color '6BADE6'
+Style -Name 'Heading 6' -Size 9 -Color '6BADE6'
+Style -Name 'NO TOC Heading 6' -Size 9 -Color '6BADE6'
+Style -Name 'NO TOC Heading 7' -Size 9 -Color '6BADE6' -Italic
 Style -Name 'Normal' -Size 10 -Color '000000' -Default
 # Header & Footer Styles
 Style -Name 'Header' -Size 10 -Color '000000' -Align Center
diff --git a/Samples/AsBuiltReport.Sample.Style-2.ps1 b/Samples/AsBuiltReport.Sample.Style-2.ps1
@@ -14,7 +14,12 @@ Style -Name 'Heading 1' -Size 16 -Color '00785F'
 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 'Heading 6' -Size 9 -Color '0072A3'
+Style -Name 'NO TOC Heading 6' -Size 9 -Color '0072A3'
+Style -Name 'NO TOC Heading 7' -Size 7 -Color '0072A3' -Italic
 Style -Name 'Normal' -Size 10 -Color '000000' -Default
 # Header & Footer Styles
 Style -Name 'Header' -Size 10 -Color '000000' -Align Left
diff --git a/Src/Public/New-AsBuiltReport.ps1 b/Src/Public/New-AsBuiltReport.ps1
