Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
tpcarman committed Feb 7, 2024
1 parent 2744aae commit d31bc93
Show file tree
Hide file tree
Showing 16 changed files with 749 additions and 2 deletions.
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
name: Bug Report
description: File a bug report
labels: ["bug"]
assignees:
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 VMware.HorizonCloud -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.VMware.HorizonCloud.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";"AsBuiltReport.VMware.HorizonCloud";"PScribo") | Select Name, Version`
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.HorizonCloud";"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.VMware.HorizonCloud/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/user-guide/known-issues/) before submitting this bug report.
required: true
- label: >-
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.HorizonCloud/issues) before submitting this bug report.
required: true
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/change_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Change Request
description: Request a new change or an improvement
labels: ["change request"]
assignees:
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.VMware.HorizonCloud/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.VMware.HorizonCloud/issues) before submitting this change request.
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] 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**](https://www.asbuiltreport.com/about/contributing/) document.
17 changes: 17 additions & 0 deletions .github/workflows/PSScriptAnalyzer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: PSScriptAnalyzer
on: [push, pull_request]
jobs:
lint:
name: Run PSScriptAnalyzer
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: lint
uses: devblackops/github-action-psscriptanalyzer@master
with:
sendComment: true
failOnErrors: true
failOnWarnings: false
failOnInfos: false
repoToken: ${{ secrets.GITHUB_TOKEN }}
settingsPath: .github/workflows/PSScriptAnalyzerSettings.psd1
8 changes: 8 additions & 0 deletions .github/workflows/PSScriptAnalyzerSettings.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@{
ExcludeRules = @(
'PSUseToExportFieldsInManifest',
'PSReviewUnusedParameter',
'PSUseDeclaredVarsMoreThanAssignments',
'PSAvoidGlobalVars'
)
}
44 changes: 44 additions & 0 deletions .github/workflows/Release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Publish PowerShell Module

on:
release:
types: [published]

jobs:
publish-to-gallery:
runs-on: windows-2019
steps:
- uses: actions/checkout@v2
- name: Set PSRepository to Trusted for PowerShell Gallery
shell: pwsh
run: |
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
- name: Install AsBuiltReport.Core module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
- name: Test Module Manifest
shell: pwsh
run: |
Test-ModuleManifest .\AsBuiltReport.VMware.HorizonCloud.psd1
- name: Publish module to PowerShell Gallery
shell: pwsh
run: |
Publish-Module -Path ./ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose
tweet:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: Eomm/why-don-t-you-tweet@v1
# We don't want to tweet if the repository is not a public one
if: ${{ !github.event.repository.private }}
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #VMware #HorizonCloud #AsBuiltReport #PowerShell"
env:
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}

25 changes: 25 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"powershell.codeFormatting.preset": "Custom",
"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.ignoreOneLineBlock": true,
"powershell.codeFormatting.newLineAfterCloseBrace": false,
"powershell.codeFormatting.newLineAfterOpenBrace": true,
"powershell.codeFormatting.openBraceOnSameLine": true,
"powershell.codeFormatting.alignPropertyValuePairs": false,
"powershell.codeFolding.enable": true,
"powershell.scriptAnalysis.enable": true,
"powershell.scriptAnalysis.settingsPath": ".github/workflows/PSScriptAnalyzerSettings.psd1",
"editor.tabSize": 4,
"editor.insertSpaces": true,
"editor.detectIndentation": false,
"editor.rulers": [
115
],
"files.trimTrailingWhitespace": true
}
104 changes: 104 additions & 0 deletions AsBuiltReport.VMware.HorizonCloud.Style.ps1

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions AsBuiltReport.VMware.HorizonCloud.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"Report": {
"Name": "VMware HorizonCloud As Built Report",
"Version": "1.0",
"Status": "Released",
"ShowCoverPageImage": true,
"ShowTableOfContents": true,
"ShowHeaderFooter": true,
"ShowTableCaptions": true
},
"Options": {

},
"InfoLevel": {
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
"_comment_": "0 = Disabled, 1 = Enabled / Summary, 2 = Adv Summary, 3 = Detailed, 4 = Adv Detailed, 5 = Comprehensive"
},
"HealthCheck": {

}
}
Loading

0 comments on commit d31bc93

Please sign in to comment.