Skip to content

Commit 25d125d

Browse files
rebelinuxrebelinux
authored
Merge pull request #20 from AsBuiltReport/dev
v0.5.2 public release
2 parents d96eeac + c999d62 commit 25d125d

File tree

62 files changed

+913
-960
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+913
-960
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ body:
9191
required: true
9292
- label: >-
9393
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
94-
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
94+
and referred to the [known issues](https://www.asbuiltreport.com/support/known-issues/) before submitting this bug report.
9595
required: true
9696
- label: >-
9797
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/issues) before submitting this bug report.

‎.github/workflows/PSScriptAnalyzer.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ jobs:
55
name: Run PSScriptAnalyzer
66
runs-on: ubuntu-latest
77
steps:
8-
- uses: actions/checkout@v2
8+
- uses: actions/checkout@v4
99
- name: lint
1010
uses: devblackops/github-action-psscriptanalyzer@master
1111
with:

‎.github/workflows/Release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
publish-to-gallery:
99
runs-on: windows-2019
1010
steps:
11-
- uses: actions/checkout@v2
11+
- uses: actions/checkout@v4
1212
- name: Set PSRepository to Trusted for PowerShell Gallery
1313
shell: pwsh
1414
run: |

‎.github/workflows/codeql.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
#
6+
# https://github.com/microsoft/action-psscriptanalyzer
7+
# For more information on PSScriptAnalyzer in general, see
8+
# https://github.com/PowerShell/PSScriptAnalyzer
9+
10+
name: CodeQL
11+
12+
on:
13+
push:
14+
branches: [ "dev" ]
15+
pull_request:
16+
branches: [ "dev" ]
17+
schedule:
18+
- cron: '20 14 * * 1'
19+
20+
permissions:
21+
contents: read
22+
23+
jobs:
24+
build:
25+
permissions:
26+
contents: read # for actions/checkout to fetch code
27+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
28+
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
29+
name: PSScriptAnalyzer
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
34+
- name: Run PSScriptAnalyzer
35+
uses: microsoft/[email protected]
36+
with:
37+
# Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
38+
# The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
39+
path: .\
40+
recurse: true
41+
# Include your own basic security rules. Removing this option will run all the rules
42+
excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
43+
output: results.sarif
44+
45+
# Upload the SARIF file generated in the previous step
46+
- name: Upload SARIF results file
47+
uses: github/codeql-action/upload-sarif@v3
48+
with:
49+
sarif_file: results.sarif

‎.vscode/settings.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
22
"powershell.codeFormatting.preset": "Custom",
3-
"powershell.codeFormatting.useCorrectCasing": true,
4-
"powershell.codeFormatting.autoCorrectAliases": true,
3+
"powershell.codeFormatting.useCorrectCasing": true,
4+
"powershell.codeFormatting.autoCorrectAliases": true,
55
"powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
66
"powershell.codeFormatting.whitespaceBeforeOpenParen": true,
77
"powershell.codeFormatting.whitespaceAroundOperator": true,
88
"powershell.codeFormatting.whitespaceAfterSeparator": true,
9-
"powershell.codeFormatting.addWhitespaceAroundPipe": true,
9+
"powershell.codeFormatting.addWhitespaceAroundPipe": true,
1010
"powershell.codeFormatting.ignoreOneLineBlock": true,
1111
"powershell.codeFormatting.newLineAfterCloseBrace": false,
1212
"powershell.codeFormatting.newLineAfterOpenBrace": true,
1313
"powershell.codeFormatting.openBraceOnSameLine": true,
14-
"powershell.codeFormatting.alignPropertyValuePairs": false,
14+
"powershell.codeFormatting.alignPropertyValuePairs": false,
1515
"powershell.codeFolding.enable": true,
16-
"powershell.scriptAnalysis.enable": true,
16+
"powershell.scriptAnalysis.enable": true,
1717
"powershell.scriptAnalysis.settingsPath": ".github/workflows/PSScriptAnalyzerSettings.psd1",
1818
"editor.tabSize": 4,
1919
"editor.insertSpaces": true,

‎AsBuiltReport.Microsoft.Windows.json‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@
88
"ShowHeaderFooter": true,
99
"ShowTableCaptions": true
1010
},
11-
"Options": {
12-
13-
},
11+
"Options": {},
1412
"InfoLevel": {
15-
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
13+
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
1614
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed, 4 = Adv Detailed, 5 = Comprehensive",
1715
"Hardware": 1,
1816
"OperatingSystem": 1,
@@ -25,7 +23,6 @@
2523
"DHCP": 1,
2624
"DNS": 1,
2725
"FailOverCluster": 1
28-
2926
},
3027
"HealthCheck": {
3128
"Networking": {
@@ -49,7 +46,12 @@
4946
"Nodes": true,
5047
"Network": true,
5148
"ClusterSharedVolume": true
52-
49+
},
50+
"Storage": {
51+
"BP": true
52+
},
53+
"SMB": {
54+
"BP": true
5355
}
5456
}
55-
}
57+
}

‎AsBuiltReport.Microsoft.Windows.psd1‎

Lines changed: 79 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -8,129 +8,129 @@
88

99
@{
1010

11-
# Script module or binary module file associated with this manifest.
12-
RootModule = 'AsBuiltReport.Microsoft.Windows.psm1'
11+
# Script module or binary module file associated with this manifest.
12+
RootModule = 'AsBuiltReport.Microsoft.Windows.psm1'
1313

14-
# Version number of this module.
15-
ModuleVersion = '0.5.1'
14+
# Version number of this module.
15+
ModuleVersion = '0.5.2'
1616

17-
# Supported PSEditions
18-
# CompatiblePSEditions = @()
17+
# Supported PSEditions
18+
# CompatiblePSEditions = @()
1919

20-
# ID used to uniquely identify this module
21-
GUID = '29c96c3d-bce4-4a9f-a429-5ba40a63d8ed'
20+
# ID used to uniquely identify this module
21+
GUID = '29c96c3d-bce4-4a9f-a429-5ba40a63d8ed'
2222

23-
# Author of this module
24-
Author = 'Andrew Ramsay'
23+
# Author of this module
24+
Author = 'Andrew Ramsay'
2525

26-
# Company or vendor of this module
27-
# CompanyName = 'Unknown'
26+
# Company or vendor of this module
27+
# CompanyName = 'Unknown'
2828

29-
# Copyright statement for this module
30-
Copyright = '(c) 2023 Andrew Ramsay. All rights reserved.'
29+
# Copyright statement for this module
30+
Copyright = '(c) 2024 Andrew Ramsay. All rights reserved.'
3131

32-
# Description of the functionality provided by this module
33-
Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft Windows.'
32+
# Description of the functionality provided by this module
33+
Description = 'A PowerShell module to generate an as built report on the configuration of Microsoft Windows.'
3434

35-
# Minimum version of the Windows PowerShell engine required by this module
36-
PowerShellVersion = '5.1'
35+
# Minimum version of the Windows PowerShell engine required by this module
36+
PowerShellVersion = '5.1'
3737

38-
# Name of the Windows PowerShell host required by this module
39-
# PowerShellHostName = ''
38+
# Name of the Windows PowerShell host required by this module
39+
# PowerShellHostName = ''
4040

41-
# Minimum version of the Windows PowerShell host required by this module
42-
# PowerShellHostVersion = ''
41+
# Minimum version of the Windows PowerShell host required by this module
42+
# PowerShellHostVersion = ''
4343

44-
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
45-
# DotNetFrameworkVersion = ''
44+
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
45+
# DotNetFrameworkVersion = ''
4646

47-
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
48-
# CLRVersion = ''
47+
# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
48+
# CLRVersion = ''
4949

50-
# Processor architecture (None, X86, Amd64) required by this module
51-
# ProcessorArchitecture = ''
50+
# Processor architecture (None, X86, Amd64) required by this module
51+
# ProcessorArchitecture = ''
5252

53-
# Modules that must be imported into the global environment prior to importing this module
54-
RequiredModules = @(
53+
# Modules that must be imported into the global environment prior to importing this module
54+
RequiredModules = @(
5555
@{
5656
ModuleName = 'AsBuiltReport.Core';
5757
ModuleVersion = '1.3.0'
5858
}
5959
)
6060

61-
# Assemblies that must be loaded prior to importing this module
62-
# RequiredAssemblies = @()
61+
# Assemblies that must be loaded prior to importing this module
62+
# RequiredAssemblies = @()
6363

64-
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
65-
# ScriptsToProcess = @()
64+
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
65+
# ScriptsToProcess = @()
6666

67-
# Type files (.ps1xml) to be loaded when importing this module
68-
# TypesToProcess = @()
67+
# Type files (.ps1xml) to be loaded when importing this module
68+
# TypesToProcess = @()
6969

70-
# Format files (.ps1xml) to be loaded when importing this module
71-
# FormatsToProcess = @()
70+
# Format files (.ps1xml) to be loaded when importing this module
71+
# FormatsToProcess = @()
7272

73-
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
74-
# NestedModules = @()
73+
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
74+
# NestedModules = @()
7575

76-
# 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.
77-
FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.Windows')
76+
# 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.
77+
FunctionsToExport = @('Invoke-AsBuiltReport.Microsoft.Windows')
7878

79-
# 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.
80-
# CmdletsToExport = '*'
79+
# 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.
80+
# CmdletsToExport = '*'
8181

82-
# Variables to export from this module
83-
# VariablesToExport = '*'
82+
# Variables to export from this module
83+
# VariablesToExport = '*'
8484

85-
# 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.
86-
# AliasesToExport = '*'
85+
# 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.
86+
# AliasesToExport = '*'
8787

88-
# DSC resources to export from this module
89-
# DscResourcesToExport = @()
88+
# DSC resources to export from this module
89+
# DscResourcesToExport = @()
9090

91-
# List of all modules packaged with this module
92-
# ModuleList = @()
91+
# List of all modules packaged with this module
92+
# ModuleList = @()
9393

94-
# List of all files packaged with this module
95-
# FileList = @()
94+
# List of all files packaged with this module
95+
# FileList = @()
9696

97-
# 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.
98-
PrivateData = @{
97+
# 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.
98+
PrivateData = @{
9999

100-
PSData = @{
101-
# Tags applied to this module. These help with module discovery in online galleries.
102-
Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'Windows'
100+
PSData = @{
101+
# Tags applied to this module. These help with module discovery in online galleries.
102+
Tags = 'AsBuiltReport', 'Report', 'Microsoft', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'Windows'
103103

104-
# A URL to the license for this module.
105-
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/LICENSE'
104+
# A URL to the license for this module.
105+
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/LICENSE'
106106

107-
# A URL to the main website for this project.
108-
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows'
107+
# A URL to the main website for this project.
108+
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows'
109109

110-
# A URL to an icon representing this module.
111-
IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
110+
# A URL to an icon representing this module.
111+
IconUri = 'https://github.com/AsBuiltReport.png'
112112

113-
# ReleaseNotes of this module
114-
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/CHANGELOG.md'
113+
# ReleaseNotes of this module
114+
ReleaseNotes = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Microsoft.Windows/master/CHANGELOG.md'
115115

116-
# Prerelease string of this module
117-
# Prerelease = ''
116+
# Prerelease string of this module
117+
# Prerelease = ''
118118

119-
# Flag to indicate whether the module requires explicit user acceptance for install/update/save
120-
# RequireLicenseAcceptance = $false
119+
# Flag to indicate whether the module requires explicit user acceptance for install/update/save
120+
# RequireLicenseAcceptance = $false
121121

122-
# External dependent modules of this module
123-
# ExternalModuleDependencies = @()
122+
# External dependent modules of this module
123+
# ExternalModuleDependencies = @()
124124

125-
} # End of PSData hashtable
125+
} # End of PSData hashtable
126126

127-
} # End of PrivateData hashtable
127+
} # End of PrivateData hashtable
128128

129-
# HelpInfo URI of this module
130-
# HelpInfoURI = ''
129+
# HelpInfo URI of this module
130+
# HelpInfoURI = ''
131131

132-
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
133-
# DefaultCommandPrefix = ''
132+
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
133+
# DefaultCommandPrefix = ''
134134

135135
}
136136

‎CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# :arrows_counterclockwise: Microsoft Windows As Built Report Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.5.2] - 2024-02-18
9+
10+
### Added
11+
12+
- Add Local Windows Group Members information @flynngw
13+
- Add more HealthCheck conditions
14+
15+
### Changed
16+
17+
- Improve report readability
18+
19+
### Fixed
20+
21+
- Fix CodeQL security alerts
22+
- Fix FailOver Cluster section
23+
- Fix issue in Get-AbrWinOSHotfix install date logic
24+
325
## [0.5.1] - 2023-05-16
426

527
### Added

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 AsBuiltReport
3+
Copyright (c) 2024 AsBuiltReport
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)