Skip to content

Commit ca68893

Browse files
tpcarmantpcarman
committed
Initial commit
1 parent c408b09 commit ca68893

15 files changed

+669
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

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+
body:
6+
- type: textarea
7+
id: bug-description
8+
attributes:
9+
label: Bug description
10+
description: >-
11+
Please provide a clear and concise description of the bug.
12+
validations:
13+
required: true
14+
- type: input
15+
id: command-line-input
16+
attributes:
17+
label: Command-line input
18+
description: >-
19+
Please provide the command line input you are using to run AsBuiltReport. Please ensure that you obscure any sensitive information.
20+
placeholder: New-AsBuiltReport -Report System.Resources -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.System.Resources.json -EnableHealthCheck -Verbose
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: steps-to-reproduce
25+
attributes:
26+
label: Steps to reproduce
27+
description: >-
28+
Please provide a detailed list of steps to reproduce the bug.
29+
placeholder: |-
30+
1. ....
31+
2. ....
32+
3. ....
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: expected-behaviour
37+
attributes:
38+
label: Expected behaviour
39+
description: >-
40+
Please provide a clear and concise description of what you expected to happen.
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: screenshots
45+
attributes:
46+
label: Screenshots
47+
description: >-
48+
Please attach any screenshots to help explain the problem. Please ensure that you obscure any sensitive information.
49+
placeholder: |-
50+
Drag and drop screenshots here.
51+
- type: textarea
52+
id: operating-system
53+
attributes:
54+
label: Operating System
55+
description: Please provide information about the operating system are you using.
56+
placeholder: macOS Big Sur, Windows 10, Ubuntu 20.04 LTS
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: powershell-version
61+
attributes:
62+
label: PowerShell Version
63+
description: Please provide information about the PowerShell version you are using. Please provide the output from the following PowerShell command `$PSVersionTable`.
64+
placeholder: $PSVersionTable
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: powershell-modules
69+
attributes:
70+
label: PowerShell Modules
71+
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.System.Resources";"PScribo") | Select Name, Version`
72+
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.System.Resources";"PScribo") | Select Name, Version
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: additional-context
77+
attributes:
78+
label: Additional Context
79+
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.System.Resources/issues) or other relevant information.
80+
- type: checkboxes
81+
id: checklist
82+
attributes:
83+
label: Before submitting
84+
description: >-
85+
Please ensure your bug report fulfills all of the following requirements.
86+
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.
87+
options:
88+
- label: >-
89+
I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
90+
required: true
91+
- label: >-
92+
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
93+
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
94+
required: true
95+
- label: >-
96+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.System.Resources/issues) before submitting this bug report.
97+
required: true
98+

‎.github/ISSUE_TEMPLATE/change_request.yml‎

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+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: >-
11+
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.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: additional-context
16+
attributes:
17+
label: Additional Context
18+
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.System.Resources/issues) or other relevant information.
19+
- type: checkboxes
20+
id: checklist
21+
attributes:
22+
label: Before submitting
23+
description: >-
24+
Please ensure your change request fulfills all of the following requirements.
25+
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.
26+
options:
27+
- label: >-
28+
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
29+
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this change request.
30+
required: true
31+
- label: >-
32+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.System.Resources/issues) before submitting this change request.
33+
required: true
34+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.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**](https://www.asbuiltreport.com/dev-guide/contributing/) document.

‎.github/workflows/PSScriptAnalyzer.yml‎

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@v5
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

‎.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: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Publish PowerShell Module
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish-to-psgallery:
9+
runs-on: windows-latest
10+
steps:
11+
- uses: actions/checkout@v4
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: Test Module Manifest
21+
shell: pwsh
22+
run: |
23+
Test-ModuleManifest .\AsBuiltReport.System.Resources.psd1
24+
- name: Publish module to PowerShell Gallery
25+
shell: pwsh
26+
run: |
27+
Publish-Module -Path ./ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose
28+
tweet:
29+
needs: publish-to-psgallery
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: Eomm/why-don-t-you-tweet@v2
33+
# We don't want to tweet if the repository is not a public one
34+
if: ${{ !github.event.repository.private }}
35+
with:
36+
# GitHub event payload
37+
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
38+
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #System #Resources #AsBuiltReport #PowerShell"
39+
env:
40+
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
41+
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
42+
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
43+
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
44+
bsky-post:
45+
needs: publish-to-psgallery
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: zentered/[email protected]
49+
with:
50+
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #System #Resources #AsBuiltReport #PowerShell"
51+
env:
52+
BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }}
53+
BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }}

‎.vscode/settings.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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+
"githubPullRequests.ignoredPullRequestBranches": [
26+
"dev"
27+
]
28+
}

‎AsBuiltReport.System.Resources/AsBuiltReport.System.Resources.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"Report": {
3+
"Name": "System Resources 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+
13+
},
14+
"InfoLevel": {
15+
"_comment_": "Please refer to the AsBuiltReport project contributing guide for information about how to define InfoLevels.",
16+
"_comment_": "0 = Disabled, 1 = Enabled / Summary, 2 = Adv Summary, 3 = Detailed, 4 = Adv Detailed, 5 = Comprehensive"
17+
},
18+
"HealthCheck": {
19+
20+
}
21+
}

0 commit comments

Comments
 (0)