Skip to content

Commit 2dec17e

Browse files
authored
Merge pull request #3 from rebelinux/master
v0.2.0 module release
2 parents 0c76fb2 + cb4eadb commit 2dec17e

27 files changed

Lines changed: 2270 additions & 0 deletions
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Desktop (please complete the following information):**
24+
- OS: [e.g. iOS]
25+
- Browser [e.g. chrome, safari]
26+
- Version [e.g. 22]
27+
28+
**Smartphone (please complete the following information):**
29+
- Device: [e.g. iPhone6]
30+
- OS: [e.g. iOS8.1]
31+
- Browser [e.g. stock browser, safari]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

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.
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@v2
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
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@{
2+
ExcludeRules = @(
3+
'PSUseToExportFieldsInManifest',
4+
'PSReviewUnusedParameter',
5+
'PSUseDeclaredVarsMoreThanAssignments',
6+
'PSAvoidGlobalVars'
7+
)
8+
}

.github/workflows/Release.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish PowerShell Module
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish-to-gallery:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Set PSRepository to Trusted for PowerShell Gallery
13+
shell: pwsh
14+
run: |
15+
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
16+
- name: Install AsBuiltReport.Core module
17+
shell: pwsh
18+
run: |
19+
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
20+
- name: Publish module to PowerShell Gallery
21+
shell: pwsh
22+
run: |
23+
Publish-Module -Path ./ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose

.vscode/settings.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"powershell.codeFormatting.preset": "Custom",
3+
"powershell.codeFormatting.useCorrectCasing": true,
4+
"powershell.codeFormatting.autoCorrectAliases": true,
5+
"powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
6+
"powershell.codeFormatting.whitespaceBeforeOpenParen": true,
7+
"powershell.codeFormatting.whitespaceAroundOperator": true,
8+
"powershell.codeFormatting.whitespaceAfterSeparator": true,
9+
"powershell.codeFormatting.addWhitespaceAroundPipe": true,
10+
"powershell.codeFormatting.ignoreOneLineBlock": true,
11+
"powershell.codeFormatting.newLineAfterCloseBrace": false,
12+
"powershell.codeFormatting.newLineAfterOpenBrace": true,
13+
"powershell.codeFormatting.openBraceOnSameLine": true,
14+
"powershell.codeFormatting.alignPropertyValuePairs": false,
15+
"powershell.codeFolding.enable": true,
16+
"powershell.scriptAnalysis.enable": true,
17+
"powershell.scriptAnalysis.settingsPath": ".github/workflows/PSScriptAnalyzerSettings.psd1",
18+
"editor.tabSize": 4,
19+
"editor.insertSpaces": true,
20+
"editor.detectIndentation": false,
21+
"editor.rulers": [
22+
115
23+
],
24+
"files.trimTrailingWhitespace": true
25+
}

AsBuiltReport.VMware.SRM.Style.ps1

Lines changed: 104 additions & 0 deletions
Large diffs are not rendered by default.

AsBuiltReport.VMware.SRM.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"Report": {
3+
"Name": "VMware SRM As Built Report",
4+
"Version": "1.0",
5+
"Status": "Released",
6+
"ShowCoverPageImage": true,
7+
"ShowTableOfContents": true,
8+
"ShowHeaderFooter": true,
9+
"ShowTableCaptions": true
10+
},
11+
"Options": {
12+
"ShowDefinitionInfo": false
13+
},
14+
"InfoLevel": {
15+
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed",
16+
"Summary": 1,
17+
"Protected": 1,
18+
"Recovery": 1,
19+
"ProtectionGroup": 1,
20+
"RecoveryPlan": 1,
21+
"InventoryMapping": 1
22+
},
23+
"HealthCheck": {
24+
"InventoryMapping": {
25+
"Status": true
26+
},
27+
"Protected": {
28+
"Status": true
29+
},
30+
"Recovery": {
31+
"Status": true
32+
}
33+
34+
}
35+
}

AsBuiltReport.VMware.SRM.psd1

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
#
2+
# Module manifest for module 'AsBuiltReport.VMware.SRM'
3+
#
4+
# Generated by: Jonathan Colon
5+
#
6+
# Generated on: 17/10/2021
7+
#
8+
9+
@{
10+
11+
# Script module or binary module file associated with this manifest.
12+
RootModule = 'AsBuiltReport.VMware.SRM.psm1'
13+
14+
# Version number of this module.
15+
ModuleVersion = '0.2.0'
16+
17+
# Supported PSEditions
18+
# CompatiblePSEditions = @()
19+
20+
# ID used to uniquely identify this module
21+
GUID = '5a38c64d-2968-404e-b323-0ff35e227917'
22+
23+
# Author of this module
24+
Author = 'Jonathan Colon'
25+
26+
# Company or vendor of this module
27+
CompanyName = 'ZenPrSolutions'
28+
29+
# Copyright statement for this module
30+
Copyright = '(c) 2021 Jonathan Colon. All rights reserved.'
31+
32+
# Description of the functionality provided by this module
33+
Description = 'A PowerShell module to generate an as built report on the configuration of VMware SRM.'
34+
35+
# Minimum version of the Windows PowerShell engine required by this module
36+
PowerShellVersion = '5.1'
37+
38+
# Name of the Windows PowerShell host required by this module
39+
# PowerShellHostName = ''
40+
41+
# Minimum version of the Windows PowerShell host required by this module
42+
# PowerShellHostVersion = ''
43+
44+
# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
45+
# DotNetFrameworkVersion = ''
46+
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 = ''
49+
50+
# Processor architecture (None, X86, Amd64) required by this module
51+
# ProcessorArchitecture = ''
52+
53+
# Modules that must be imported into the global environment prior to importing this module
54+
RequiredModules = @(
55+
@{
56+
ModuleName = 'AsBuiltReport.Core';
57+
ModuleVersion = '1.1.0'
58+
}
59+
)
60+
61+
# Assemblies that must be loaded prior to importing this module
62+
# RequiredAssemblies = @()
63+
64+
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
65+
# ScriptsToProcess = @()
66+
67+
# Type files (.ps1xml) to be loaded when importing this module
68+
# TypesToProcess = @()
69+
70+
# Format files (.ps1xml) to be loaded when importing this module
71+
# FormatsToProcess = @()
72+
73+
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
74+
# NestedModules = @()
75+
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.VMware.SRM'
78+
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 = '*'
81+
82+
# Variables to export from this module
83+
#VariablesToExport = '*'
84+
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 = '*'
87+
88+
# DSC resources to export from this module
89+
# DscResourcesToExport = @()
90+
91+
# List of all modules packaged with this module
92+
# ModuleList = @()
93+
94+
# List of all files packaged with this module
95+
# FileList = @()
96+
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 = @{
99+
100+
PSData = @{
101+
102+
# Tags applied to this module. These help with module discovery in online galleries.
103+
Tags = @('AsBuiltReport', 'Report', 'VMware', 'SRM', 'Documentation', 'PScribo', 'PSEdition_Desktop', 'PSEdition_Core', 'Windows', 'MacOS', 'Linux')
104+
105+
# A URL to the license for this module.
106+
LicenseUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.VMware.SRM/master/LICENSE'
107+
108+
# A URL to the main website for this project.
109+
ProjectUri = 'https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM'
110+
111+
# A URL to an icon representing this module.
112+
IconUri = 'https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport/master/AsBuiltReport.png'
113+
114+
# ReleaseNotes of this module
115+
ReleaseNotes = 'https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/blob/master/CHANGELOG.md'
116+
117+
} # End of PSData hashtable
118+
119+
} # End of PrivateData hashtable
120+
121+
# HelpInfo URI of this module
122+
# HelpInfoURI = ''
123+
124+
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
125+
# DefaultCommandPrefix = ''
126+
127+
}
128+
129+

0 commit comments

Comments
 (0)