Merge pull request #20 from AsBuiltReport/dev

v0.5.2 public release
AsBuiltReport · Feb 17, 2024 · 25d125d · 25d125d
2 parents d96eeac + c999d62
commit 25d125d
Show file tree

Hide file tree

Showing 62 changed files with 913 additions and 960 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -91,7 +91,7 @@ body:
           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.
+            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.Microsoft.Windows/issues) before submitting this bug report.

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: windows-2019
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set PSRepository to Trusted for PowerShell Gallery
         shell: pwsh
         run: |

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,49 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+#
+# https://github.com/microsoft/action-psscriptanalyzer
+# For more information on PSScriptAnalyzer in general, see
+# https://github.com/PowerShell/PSScriptAnalyzer
+
+name: CodeQL
+
+on:
+  push:
+    branches: [ "dev" ]
+  pull_request:
+    branches: [ "dev" ]
+  schedule:
+    - cron: '20 14 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: PSScriptAnalyzer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run PSScriptAnalyzer
+        uses: microsoft/[email protected]
+        with:
+          # Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
+          # The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
+          path: .\
+          recurse: true
+          # Include your own basic security rules. Removing this option will run all the rules
+          excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
+          output: results.sarif
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,19 +1,19 @@
 {
     "powershell.codeFormatting.preset": "Custom",
-	"powershell.codeFormatting.useCorrectCasing": true,
-	"powershell.codeFormatting.autoCorrectAliases": true,
+    "powershell.codeFormatting.useCorrectCasing": true,
+    "powershell.codeFormatting.autoCorrectAliases": true,
     "powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
     "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
-	"powershell.codeFormatting.addWhitespaceAroundPipe": true,
+    "powershell.codeFormatting.addWhitespaceAroundPipe": true,
     "powershell.codeFormatting.ignoreOneLineBlock": true,
     "powershell.codeFormatting.newLineAfterCloseBrace": false,
     "powershell.codeFormatting.newLineAfterOpenBrace": true,
     "powershell.codeFormatting.openBraceOnSameLine": true,
-	"powershell.codeFormatting.alignPropertyValuePairs": false,
+    "powershell.codeFormatting.alignPropertyValuePairs": false,
     "powershell.codeFolding.enable": true,
-	"powershell.scriptAnalysis.enable": true,
+    "powershell.scriptAnalysis.enable": true,
     "powershell.scriptAnalysis.settingsPath": ".github/workflows/PSScriptAnalyzerSettings.psd1",
     "editor.tabSize": 4,
     "editor.insertSpaces": true,

diff --git a/AsBuiltReport.Microsoft.Windows.json b/AsBuiltReport.Microsoft.Windows.json
@@ -8,11 +8,9 @@
         "ShowHeaderFooter": true,
         "ShowTableCaptions": true
     },
-    "Options": {
-
-    },
+    "Options": {},
     "InfoLevel": {
-		"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
+        "_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
         "_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed, 4 = Adv Detailed, 5 = Comprehensive",
         "Hardware": 1,
         "OperatingSystem": 1,
@@ -25,7 +23,6 @@
         "DHCP": 1,
         "DNS": 1,
         "FailOverCluster": 1
-
     },
     "HealthCheck": {
         "Networking": {
@@ -49,7 +46,12 @@
             "Nodes": true,
             "Network": true,
             "ClusterSharedVolume": true
-
+        },
+        "Storage": {
+            "BP": true
+        },
+        "SMB": {
+            "BP": true
         }
     }
-}
+}
diff --git a/AsBuiltReport.Microsoft.Windows.psd1 b/AsBuiltReport.Microsoft.Windows.psd1
@@ -8,129 +8,129 @@
 
 @{
 
-# Script module or binary module file associated with this manifest.
-RootModule = 'AsBuiltReport.Microsoft.Windows.psm1'
+    # Script module or binary module file associated with this manifest.
+    RootModule = 'AsBuiltReport.Microsoft.Windows.psm1'
 
-# Version number of this module.
-ModuleVersion = '0.5.1'
+    # Version number of this module.
+    ModuleVersion = '0.5.2'
 
-# Supported PSEditions
-# CompatiblePSEditions = @()
+    # Supported PSEditions
+    # CompatiblePSEditions = @()
 
-# ID used to uniquely identify this module
-GUID = '29c96c3d-bce4-4a9f-a429-5ba40a63d8ed'
+    # ID used to uniquely identify this module
+    GUID = '29c96c3d-bce4-4a9f-a429-5ba40a63d8ed'
 
-# Author of this module
-Author = 'Andrew Ramsay'
+    # Author of this module
+    Author = 'Andrew Ramsay'
 
-# Company or vendor of this module
-# CompanyName = 'Unknown'
+    # Company or vendor of this module
+    # CompanyName = 'Unknown'
 
-# Copyright statement for this module
-Copyright = '(c) 2023 Andrew Ramsay. All rights reserved.'
+    # Copyright statement for this module
+    Copyright = '(c) 2024 Andrew Ramsay. All rights reserved.'
 
-# Description of the functionality provided by this module
-Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft Windows.'
+    # Description of the functionality provided by this module
+    Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft Windows.'
 
-# Minimum version of the Windows PowerShell engine required by this module
-PowerShellVersion = '5.1'
+    # Minimum version of the Windows PowerShell engine required by this module
+    PowerShellVersion = '5.1'
 
-# Name of the Windows PowerShell host required by this module
-# PowerShellHostName = ''
+    # Name of the Windows PowerShell host required by this module
+    # PowerShellHostName = ''
 
-# Minimum version of the Windows PowerShell host required by this module
-# PowerShellHostVersion = ''
+    # Minimum version of the Windows PowerShell host required by this module
+    # PowerShellHostVersion = ''
 
-# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# DotNetFrameworkVersion = ''
+    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # DotNetFrameworkVersion = ''
 
-# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-# CLRVersion = ''
+    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+    # CLRVersion = ''
 
-# Processor architecture (None, X86, Amd64) required by this module
-# ProcessorArchitecture = ''
+    # Processor architecture (None, X86, Amd64) required by this module
+    # ProcessorArchitecture = ''
 
-# Modules that must be imported into the global environment prior to importing this module
-RequiredModules = @(
+    # Modules that must be imported into the global environment prior to importing this module
+    RequiredModules = @(
         @{
             ModuleName = 'AsBuiltReport.Core';
             ModuleVersion = '1.3.0'
         }
     )
 
-# Assemblies that must be loaded prior to importing this module
-# RequiredAssemblies = @()
+    # Assemblies that must be loaded prior to importing this module
+    # RequiredAssemblies = @()
 
-# Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = @()
+    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
+    # ScriptsToProcess = @()
 
-# Type files (.ps1xml) to be loaded when importing this module
-# TypesToProcess = @()
+    # Type files (.ps1xml) to be loaded when importing this module
+    # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
-# FormatsToProcess = @()
+    # Format files (.ps1xml) to be loaded when importing this module
+    # FormatsToProcess = @()
 
-# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-# NestedModules = @()
+    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+    # NestedModules = @()
 
-# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.Windows')
+    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+    FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.Windows')
 
-# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-# CmdletsToExport = '*'
+    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+    # CmdletsToExport = '*'
 
-# Variables to export from this module
-# VariablesToExport = '*'
+    # Variables to export from this module
+    # VariablesToExport = '*'
 
-# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-# AliasesToExport = '*'
+    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+    # AliasesToExport = '*'
 
-# DSC resources to export from this module
-# DscResourcesToExport = @()
+    # DSC resources to export from this module
+    # DscResourcesToExport = @()
 
-# List of all modules packaged with this module
-# ModuleList = @()
+    # List of all modules packaged with this module
+    # ModuleList = @()
 
-# List of all files packaged with this module
-# FileList = @()
+    # List of all files packaged with this module
+    # FileList = @()
 
-# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-PrivateData = @{
+    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+    PrivateData = @{
 
-    PSData = @{
-        # Tags applied to this module. These help with module discovery in online galleries.
-        Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'Windows'
+        PSData = @{
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'Windows'
 
-        # A URL to the license for this module.
-        LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/LICENSE'
+            # A URL to the license for this module.
+            LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/LICENSE'
 
-        # A URL to the main website for this project.
-        ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows'
+            # A URL to the main website for this project.
+            ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows'
 
-        # A URL to an icon representing this module.
-        IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
+            # A URL to an icon representing this module.
+            IconUri = 'https://github.com/AsBuiltReport.png'
 
-        # ReleaseNotes of this module
-        ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/CHANGELOG.md'
+            # ReleaseNotes of this module
+            ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/CHANGELOG.md'
 
-        # Prerelease string of this module
-        # Prerelease = ''
+            # Prerelease string of this module
+            # Prerelease = ''
 
-        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
-        # RequireLicenseAcceptance = $false
+            # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+            # RequireLicenseAcceptance = $false
 
-        # External dependent modules of this module
-        # ExternalModuleDependencies = @()
+            # External dependent modules of this module
+            # ExternalModuleDependencies = @()
 
-    } # End of PSData hashtable
+        } # End of PSData hashtable
 
-} # End of PrivateData hashtable
+    } # End of PrivateData hashtable
 
-# HelpInfo URI of this module
-# HelpInfoURI = ''
+    # HelpInfo URI of this module
+    # HelpInfoURI = ''
 
-# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-# DefaultCommandPrefix = ''
+    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+    # DefaultCommandPrefix = ''
 
 }
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,27 @@
 # :arrows_counterclockwise: Microsoft Windows As Built Report 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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.2] - 2024-02-18
+
+### Added
+
+- Add Local Windows Group Members information @flynngw
+- Add more HealthCheck conditions
+
+### Changed
+
+- Improve report readability
+
+### Fixed
+
+- Fix CodeQL security alerts
+- Fix FailOver Cluster section
+- Fix issue in Get-AbrWinOSHotfix install date logic
+
 ## [0.5.1] - 2023-05-16
 
 ### 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