From af73a7cea355b90120a0f8f57111c1ca50b7e485 Mon Sep 17 00:00:00 2001 From: Jonathan Colon Date: Sat, 6 Sep 2025 20:40:29 -0400 Subject: [PATCH] More fixes, update ChangeLog and Improve bug and feature request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 98 +++++++++++++++++++ .github/ISSUE_TEMPLATE/change_request.yml | 34 +++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 17 ---- .github/workflows/Codeql.yml | 2 +- .github/workflows/Release.yml | 2 +- CHANGELOG.md | 36 ++++--- README.md | 8 +- .../Get-AbrVmmInfrastructureDiagram.ps1 | 2 +- Todo.md | 2 +- 11 files changed, 167 insertions(+), 70 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/change_request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b735373..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..c731d4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,98 @@ +name: Bug Report +description: File a bug report +labels: ["bug"] +assignees: + - rebelinux +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 Microsoft.SCVMM -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.Microsoft.SCVMM.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: Windows Server 2022, Windows 2019, etc. + 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.Microsoft.SCVMM";"PScribo") | Select Name, Version` + placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.Microsoft.SCVMM";"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.Microsoft.SCVMM/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.Microsoft.SCVMM/issues) before submitting this bug report. + required: true diff --git a/.github/ISSUE_TEMPLATE/change_request.yml b/.github/ISSUE_TEMPLATE/change_request.yml new file mode 100644 index 0000000..57908c3 --- /dev/null +++ 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: + - rebelinux +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.Microsoft.SCVMM/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.Microsoft.SCVMM/issues) before submitting this change request. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/Codeql.yml b/.github/workflows/Codeql.yml index 832aa3e..290327c 100644 --- a/.github/workflows/Codeql.yml +++ b/.github/workflows/Codeql.yml @@ -27,7 +27,7 @@ jobs: name: PSScriptAnalyzer runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Run PSScriptAnalyzer uses: microsoft/psscriptanalyzer-action@v1.1 diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml index dd8ce4f..75de3bd 100644 --- a/.github/workflows/Release.yml +++ b/.github/workflows/Release.yml @@ -28,7 +28,7 @@ jobs: - name: Test Module Manifest shell: pwsh run: | - Test-ModuleManifest .\AsBuiltReport.Veeam.VBR.psd1 + Test-ModuleManifest .\AsBuiltReport.Microsoft.SCVMM.psd1 - name: Publish module to PowerShell Gallery shell: pwsh run: | diff --git a/CHANGELOG.md b/CHANGELOG.md index 6878fbb..28e4533 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,33 @@ -# :arrows_counterclockwise: Microsoft SCVMM As Built Report Changelog +# :arrows_clockwise: Microsoft SCVMM As Built Report Changelog -## [0.1.1] - 2024-06-10 +All notable changes to this project will be documented in this file. -### Added +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). -- Initial release of Microsoft SCVMM As Built Report module. -- Basic changelog structure. +##### This project is community maintained and has no sponsorship from Microsoft, its employees or any of its affiliates. -### Changed -- N/A +## [0.1.1] - 2025-09-06 -### Fixed -- N/A +### Added -### Removed -- N/A +- Prepare report for initial release to the public. +- Add Infrastructure diagram +- Add Update Server information +- Add vCenter Server information +- Add configuration settings + - RunAs Accounts + - User Roles +- Add HostGroup (Get-SCVMHostGroup) +- Add Diagrammer.Core module to module requirements +- Add PScriboCharts module to module requirements +- Add GitHub release workflow for X(Twitter)/Bluesky social platform + +### Changed +- Increased module version to v0.1.1 +- Migrate report to new module format +- Increase AsBuiltReport.Core module version v1.4.3 +- Refactor WinRM connection logic in Cluster section +- Improve bug and feature request templates diff --git a/README.md b/README.md index e660b79..6d20a6d 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ Buy Me a Coffee at ko-fi.com

+#### This project is community maintained and has no sponsorship from Microsoft, its employees or any of its affiliates. + # Microsoft SCVMM As Built Report Microsoft SCVMM As Built Report is a PowerShell module which works in conjunction with [AsBuiltReport.Core](https://github.com/AsBuiltReport/AsBuiltReport.Core). @@ -55,9 +57,9 @@ The Microsoft SCVMM As Built Report supports the following SCVMM Server versions This report is compatible with the following PowerShell versions; -| Windows PowerShell 5.1 | PowerShell 7 | -| :--------------------: | :----------------: | -| :white_check_mark: | :x: | +| Windows PowerShell 5.1 | PowerShell 7 | +| :--------------------: | :----------: | +| :white_check_mark: | :x: | ## :wrench: System Requirements diff --git a/Src/Private/Get-AbrVmmInfrastructureDiagram.ps1 b/Src/Private/Get-AbrVmmInfrastructureDiagram.ps1 index 288764c..910a1dd 100644 --- a/Src/Private/Get-AbrVmmInfrastructureDiagram.ps1 +++ b/Src/Private/Get-AbrVmmInfrastructureDiagram.ps1 @@ -56,7 +56,7 @@ function Get-AbrVmmInfrastructureDiagram { $VMMVirtualizationManagers = Get-SCVirtualizationManager -VMMServer $ConnectVmmServer | Sort-Object -Property Name $VMMServerAdditionalInfo = [pscustomobject][Ordered]@{ - 'IP Address' = (Get-NetIPAddress -CimSession $VMMCimSession -AddressFamily IPv4 | Where-Object { $_.IPAddress -notlike "127.0.0.1" })[0].IPAddress + 'IP Address' = Get-NodeIP -Hostname $VMM.FQDN 'Server Port' = $VMM.Port 'Version' = $VMM.ProductVersion 'Role' = "VMM Server" diff --git a/Todo.md b/Todo.md index 15a2605..b51ebde 100644 --- a/Todo.md +++ b/Todo.md @@ -1,6 +1,6 @@ [x] Add Update Server [] Add PXE Server -[] Add vCenter Server +[x] Add vCenter Server [] Add Network Service [x] Add configuration settings [x] Get-SCRunAsAccount