Skip to content

Commit 065459c

Browse files
committed
feat: Enhance diagram support and update module dependencies
- Added options for diagram generation in AsBuiltReport.VMware.Horizon.json. - Introduced Export-AbrDiagram function to handle diagram exports in various formats. - Created Get-AbrHRZInfrastructureDiagram function for generating infrastructure diagrams. - Updated Invoke-ASBuiltReport to check for required module versions and provide user feedback. - Added icons for branding in the report. - Bumped module versions for AsBuiltReport.Core and added Diagrammer.Core as a dependency. - Updated CHANGELOG.md to reflect recent changes and enhancements.
1 parent 0075a98 commit 065459c

File tree

79 files changed

+9205
-35
lines changed

Some content is hidden

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

79 files changed

+9205
-35
lines changed

.github/workflows/Codeql.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
name: PSScriptAnalyzer
2828
runs-on: ubuntu-latest
2929
steps:
30-
- uses: actions/checkout@v4
30+
- uses: actions/checkout@v5
3131

3232
- name: Run PSScriptAnalyzer
3333
uses: microsoft/[email protected]

.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@v4
8+
- uses: actions/checkout@v5
99
- name: lint
1010
uses: devblackops/github-action-psscriptanalyzer@master
1111
with:

.github/workflows/PSScriptAnalyzerSettings.psd1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
'PSUseToExportFieldsInManifest',
44
'PSReviewUnusedParameter',
55
'PSUseDeclaredVarsMoreThanAssignments',
6-
'PSAvoidGlobalVars'
6+
'PSAvoidGlobalVars',
7+
'PSAvoidUsingWriteHost'
78
)
89
}

.github/workflows/Release.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ on:
66

77
jobs:
88
publish-to-gallery:
9-
runs-on: windows-2019
9+
runs-on: windows-latest
1010
steps:
11-
- uses: actions/checkout@v4
11+
- uses: actions/checkout@v5
1212
- name: Set PSRepository to Trusted for PowerShell Gallery
1313
shell: pwsh
1414
run: |
@@ -17,6 +17,10 @@ jobs:
1717
shell: pwsh
1818
run: |
1919
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
20+
- name: Install Diagrammer.Core module
21+
shell: pwsh
22+
run: |
23+
Install-Module -Name Diagrammer.Core -Repository PSGallery -Force
2024
- name: Test Module Manifest
2125
shell: pwsh
2226
run: |
@@ -45,7 +49,7 @@ jobs:
4549
needs: publish-to-gallery
4650
runs-on: ubuntu-latest
4751
steps:
48-
- uses: zentered/bluesky-post-action@v0.1.0
52+
- uses: zentered/bluesky-post-action@v0.3.0
4953
with:
5054
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Omnissa #VMware #Horizon #vExpert #AsBuiltReport #PowerShell"
5155
env:
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["bug"]
4+
assignees:
5+
- childebrandt42
6+
body:
7+
- type: textarea
8+
id: bug-description
9+
attributes:
10+
label: Bug description
11+
description: >-
12+
Please provide a clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: input
16+
id: command-line-input
17+
attributes:
18+
label: Command-line input
19+
description: >-
20+
Please provide the command line input you are using to run AsBuiltReport. Please ensure that you obscure any sensitive information.
21+
placeholder: New-AsBuiltReport -Report VMware.Horizon -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.VMware.Horizon.json -EnableHealthCheck -Verbose
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: steps-to-reproduce
26+
attributes:
27+
label: Steps to reproduce
28+
description: >-
29+
Please provide a detailed list of steps to reproduce the bug.
30+
placeholder: |-
31+
1. ....
32+
2. ....
33+
3. ....
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: expected-behaviour
38+
attributes:
39+
label: Expected behaviour
40+
description: >-
41+
Please provide a clear and concise description of what you expected to happen.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: screenshots
46+
attributes:
47+
label: Screenshots
48+
description: >-
49+
Please attach any screenshots to help explain the problem. Please ensure that you obscure any sensitive information.
50+
placeholder: |-
51+
Drag and drop screenshots here.
52+
- type: textarea
53+
id: operating-system
54+
attributes:
55+
label: Operating System
56+
description: Please provide information about the operating system are you using.
57+
placeholder: macOS Big Sur, Windows 10, Ubuntu 20.04 LTS
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: powershell-version
62+
attributes:
63+
label: PowerShell Version
64+
description: Please provide information about the PowerShell version you are using. Please provide the output from the following PowerShell command `$PSVersionTable`.
65+
placeholder: $PSVersionTable
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: powershell-modules
70+
attributes:
71+
label: PowerShell Modules
72+
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.Horizon";"PScribo") | Select Name, Version`
73+
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.Horizon";"PScribo") | Select Name, Version
74+
validations:
75+
required: true
76+
- type: textarea
77+
id: additional-context
78+
attributes:
79+
label: Additional Context
80+
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.Horizon/issues) or other relevant information.
81+
- type: checkboxes
82+
id: checklist
83+
attributes:
84+
label: Before submitting
85+
description: >-
86+
Please ensure your bug report fulfills all of the following requirements.
87+
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.
88+
options:
89+
- label: >-
90+
I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
91+
required: true
92+
- label: >-
93+
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.
95+
required: true
96+
- label: >-
97+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon/issues) before submitting this bug report.
98+
required: true
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Change Request
2+
description: Request a new change or an improvement
3+
labels: ["change request"]
4+
assignees:
5+
- childebrandt42
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: >-
12+
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.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: additional-context
17+
attributes:
18+
label: Additional Context
19+
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.Horizon/issues) or other relevant information.
20+
- type: checkboxes
21+
id: checklist
22+
attributes:
23+
label: Before submitting
24+
description: >-
25+
Please ensure your change request fulfills all of the following requirements.
26+
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.
27+
options:
28+
- label: >-
29+
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
30+
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this change request.
31+
required: true
32+
- label: >-
33+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.Horizon/issues) before submitting this change request.
34+
required: true
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screenshots (if appropriate):
21+
22+
## Types of changes
23+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27+
28+
## Checklist:
29+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
- [ ] My code follows the code style of this project.
32+
- [ ] My change requires a change to the documentation.
33+
- [ ] I have updated the documentation accordingly.
34+
- [ ] I have read the [**CONTRIBUTING**](/CONTRIBUTING.md) document.

1.1.5/.github/workflows/Codeql.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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+
18+
permissions:
19+
contents: read
20+
21+
jobs:
22+
build:
23+
permissions:
24+
contents: read # for actions/checkout to fetch code
25+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
26+
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
27+
name: PSScriptAnalyzer
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@v4
31+
32+
- name: Run PSScriptAnalyzer
33+
uses: microsoft/[email protected]
34+
with:
35+
# Check https://github.com/microsoft/action-psscriptanalyzer for more info about the options.
36+
# The below set up runs PSScriptAnalyzer to your entire repository and runs some basic security rules.
37+
path: .\
38+
recurse: true
39+
# Include your own basic security rules. Removing this option will run all the rules
40+
excludeRule: '"PSAvoidUsingPlainTextForPassword", "PSAvoidUsingUsernameAndPasswordParams", "PSAvoidUsingConvertToSecureStringWithPlainText"'
41+
output: results.sarif
42+
43+
# Upload the SARIF file generated in the previous step
44+
- name: Upload SARIF results file
45+
uses: github/codeql-action/upload-sarif@v3
46+
with:
47+
sarif_file: results.sarif
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: PSScriptAnalyzer
2+
on: [push, pull_request]
3+
jobs:
4+
lint:
5+
name: Run PSScriptAnalyzer
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v4
9+
- name: lint
10+
uses: devblackops/github-action-psscriptanalyzer@master
11+
with:
12+
sendComment: true
13+
failOnErrors: true
14+
failOnWarnings: false
15+
failOnInfos: false
16+
repoToken: ${{ secrets.GITHUB_TOKEN }}
17+
settingsPath: .github/workflows/PSScriptAnalyzerSettings.psd1

0 commit comments

Comments
 (0)