Skip to content

Commit 04d7eb9

Browse files
raandreeraandree
committed
Initial upload
1 parent 78ebd9f commit 04d7eb9

File tree

62 files changed

+3307
-0
lines changed

Some content is hidden

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

62 files changed

+3307
-0
lines changed

‎.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
2+
* text eol=autocrlf
3+
4+
*.mof text eol=crlf
5+
*.sh text eol=lf
6+
*.svg eol=lf
7+
8+
# Ensure any exe files are treated as binary
9+
*.exe binary
10+
*.jpg binary
11+
*.xl* binary
12+
*.pfx binary
13+
*.png binary
14+
*.dll binary
15+
*.so binary

‎.github/ISSUE_TEMPLATE/General.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: General question or documentation update
3+
about: If you have a general question or documentation update suggestion around the resource module.
4+
---
5+
<!--
6+
Your feedback and support is greatly appreciated, thanks for contributing!
7+
-->

‎.github/ISSUE_TEMPLATE/Problem_with_module.yml

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: Problem with the module
2+
description: If you have a problem using this module, want to report a bug, or suggest an enhancement to this module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
TITLE: Please be descriptive not sensationalist.
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
13+
Please provide information regarding your issue under each section below.
14+
**Write N/A in sections that do not apply, or if the information is not available.**
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Problem description
19+
description: Details of the scenario you tried and the problem that is occurring, or the enhancement you are suggesting.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: logs
24+
attributes:
25+
label: Verbose logs
26+
description: |
27+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
28+
placeholder: |
29+
Paste verbose logs here
30+
render: text
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproducible
35+
attributes:
36+
label: How to reproduce
37+
description: Provide the steps to reproduce the problem.
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: expectedBehavior
42+
attributes:
43+
label: Expected behavior
44+
description: Describe what you expected to happen.
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: currentBehavior
49+
attributes:
50+
label: Current behavior
51+
description: Describe what actually happens.
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: suggestedSolution
56+
attributes:
57+
label: Suggested solution
58+
description: Do you have any suggestions how to solve the issue?
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: targetNodeOS
63+
attributes:
64+
label: Operating system the target node is running
65+
description: |
66+
Please provide as much as possible about the node running DscConfig.Demo. _Will be automatically formatted as plain text._
67+
68+
To help with this information:
69+
- On a Linux distribution, please provide the distribution name, version, and release. The following command can help get this information: `cat /etc/*-release && cat /proc/version`
70+
- On a Windows OS please provide edition, version, build, and language. The following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
71+
placeholder: |
72+
Add operating system information here
73+
render: text
74+
validations:
75+
required: true
76+
- type: textarea
77+
id: targetNodePS
78+
attributes:
79+
label: PowerShell version and build the target node is running
80+
description: |
81+
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
82+
83+
To help with this information, please run this command: `$PSVersionTable`
84+
placeholder: |
85+
Add PowerShell information here
86+
render: text
87+
validations:
88+
required: true
89+
- type: textarea
90+
id: moduleVersion
91+
attributes:
92+
label: Module version used
93+
description: |
94+
Please provide the version of the DscConfig.Demo module that was used. _Will be automatically formatted as plain text._
95+
96+
To help with this information, please run this command: `Get-Module -Name 'DscConfig.Demo' -ListAvailable | ft Name,Version,Path`
97+
placeholder: |
98+
Add module information here
99+
render: text
100+
validations:
101+
required: true

‎.github/ISSUE_TEMPLATE/Problem_with_resource.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Problem with a resource
2+
description: If you have a problem, bug, or enhancement with a resource in this resource module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Problem description
16+
description: Details of the scenario you tried and the problem that is occurring.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: logs
21+
attributes:
22+
label: Verbose logs
23+
description: |
24+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
25+
placeholder: |
26+
Paste verbose logs here
27+
render: text
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: configuration
32+
attributes:
33+
label: DSC configuration
34+
description: |
35+
The DSC configuration that is used to reproduce the issue (as detailed as possible). **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as PowerShell code._
36+
placeholder: |
37+
Paste DSC configuration here
38+
render: powershell
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: suggestedSolution
43+
attributes:
44+
label: Suggested solution
45+
description: Do you have any suggestions how to solve the issue?
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: targetNodeOS
50+
attributes:
51+
label: Operating system the target node is running
52+
description: |
53+
Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
54+
55+
On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
56+
placeholder: |
57+
Add operating system information here
58+
render: text
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: targetNodePS
63+
attributes:
64+
label: PowerShell version and build the target node is running
65+
description: |
66+
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
67+
68+
To help with this information, please run this command: `$PSVersionTable`
69+
placeholder: |
70+
Add PowerShell information here
71+
render: text
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: moduleVersion
76+
attributes:
77+
label: DscConfig.Demo version
78+
description: |
79+
Please provide the version of the DscConfig.Demo module that was used. _Will be automatically formatted as plain text._
80+
81+
To help with this information, please run this command: `Get-Module -Name 'DscConfig.Demo' -ListAvailable | ft Name,Version,Path`
82+
placeholder: |
83+
Add module information here
84+
render: text
85+
validations:
86+
required: true

‎.github/ISSUE_TEMPLATE/Resource_proposal.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: New resource proposal
2+
description: If you have a new resource proposal that you think should be added to this resource module.
3+
title: "NewResourceName: New resource proposal"
4+
labels: []
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
11+
12+
Thank you for contributing and making this resource module better!
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Resource proposal
17+
description: Provide information how this resource will/should work and how it will help users.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: proposedProperties
22+
attributes:
23+
label: Proposed properties
24+
description: |
25+
List all the proposed properties that the resource should have (key, required, write, and/or read). For each property provide a detailed description, the data type, if a default value should be used, and if the property is limited to a set of values.
26+
value: |
27+
Property | Type qualifier | Data type | Description | Default value | Allowed values
28+
--- | --- | --- | --- | --- | ---
29+
PropertyName | Key | String | Detailed description | None | None
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: considerations
34+
attributes:
35+
label: Special considerations or limitations
36+
description: |
37+
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed resource, and or what limitations a user will encounter or should consider when using the proposed resource.
38+
validations:
39+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "Virtual PowerShell User Group #DSC channel"
4+
url: https://dsccommunity.org/community/contact/
5+
about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."
6+

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Pull Request
2+
3+
<!--
4+
Thanks for submitting a Pull Request (PR) to this project.
5+
Your contribution to this project is greatly appreciated!
6+
7+
TITLE: Please be descriptive not sensationalist.
8+
Prepend the title with the [DscResourceName] if your PR is specific to a DSC resource.
9+
Also prepend with [BREAKING CHANGE] if relevant.
10+
i.e. [BREAKING CHANGE][xFile] Add security descriptor property
11+
12+
You may remove this comment block, and the other comment blocks, but please
13+
keep the headers and the task list.
14+
Try to keep your PRs atomic: changes grouped in smallest batch affecting a single logical unit.
15+
-->
16+
17+
## Pull Request (PR) description
18+
19+
<!--
20+
Replace this comment block with a description of your PR to provide context.
21+
Please be describe the intent and link issue where the problem has been discussed.
22+
try to link the issue that it fixes by providing the verb and ref: [fix|close #18]
23+
24+
After the description, please concisely list the changes as per keepachangelog.com
25+
This **should** duplicate what you've updated in the changelog file.
26+
27+
### Added
28+
- for new features [closes #15]
29+
### Changed
30+
- for changes in existing functionality.
31+
### Deprecated
32+
- for soon-to-be removed features.
33+
### Security
34+
- in case of vulnerabilities.
35+
### Fixed
36+
- for any bug fixes. [fix #52]
37+
### Removed
38+
- for now removed features.
39+
-->
40+
41+
## Task list
42+
43+
<!--
44+
To aid community reviewers in reviewing and merging your PR, please take
45+
the time to run through the below checklist and make sure your PR has
46+
everything updated as required.
47+
48+
Change to [x] for each task in the task list that applies to your PR.
49+
For those task that don't apply to you PR, leave those as is.
50+
-->
51+
52+
- [ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
53+
- [ ] Added an entry under the Unreleased section of in the CHANGELOG.md as per [format](https://keepachangelog.com/en/1.0.0/).
54+
- [ ] Local clean build passes without issue or fail tests (`build.ps1 -ResolveDependency`).
55+
- [ ] Resource documentation added/updated in README.md.
56+
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
57+
and comment-based help.
58+
- [ ] Comment-based help added/updated.
59+
- [ ] Localization strings added/updated in all localization files as appropriate.
60+
- [ ] Examples appropriately added/updated.
61+
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
62+
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
63+
- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).

‎.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
output/
2+
3+
**.bak
4+
*.local.*
5+
!**/README.md
6+
.kitchen/
7+
8+
*.suo
9+
*.user
10+
*.coverage
11+
.vs
12+
.psproj
13+
.sln
14+
markdownissues.txt
15+
node_modules
16+
package-lock.json

‎.markdownlint.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"default": true,
3+
"MD029": {
4+
"style": "one"
5+
},
6+
"MD013": true,
7+
"MD024": false,
8+
"MD034": false,
9+
"no-hard-tabs": true
10+
}

‎.vscode/analyzersettings.psd1

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
@{
2+
CustomRulePath = '.\output\RequiredModules\DscResource.AnalyzerRules'
3+
includeDefaultRules = $true
4+
IncludeRules = @(
5+
# DSC Resource Kit style guideline rules.
6+
'PSAvoidDefaultValueForMandatoryParameter',
7+
'PSAvoidDefaultValueSwitchParameter',
8+
'PSAvoidInvokingEmptyMembers',
9+
'PSAvoidNullOrEmptyHelpMessageAttribute',
10+
'PSAvoidUsingCmdletAliases',
11+
'PSAvoidUsingComputerNameHardcoded',
12+
'PSAvoidUsingDeprecatedManifestFields',
13+
'PSAvoidUsingEmptyCatchBlock',
14+
'PSAvoidUsingInvokeExpression',
15+
'PSAvoidUsingPositionalParameters',
16+
'PSAvoidShouldContinueWithoutForce',
17+
'PSAvoidUsingWMICmdlet',
18+
'PSAvoidUsingWriteHost',
19+
'PSDSCReturnCorrectTypesForDSCFunctions',
20+
'PSDSCStandardDSCFunctionsInResource',
21+
'PSDSCUseIdenticalMandatoryParametersForDSC',
22+
'PSDSCUseIdenticalParametersForDSC',
23+
'PSMisleadingBacktick',
24+
'PSMissingModuleManifestField',
25+
'PSPossibleIncorrectComparisonWithNull',
26+
'PSProvideCommentHelp',
27+
'PSReservedCmdletChar',
28+
'PSReservedParams',
29+
'PSUseApprovedVerbs',
30+
'PSUseCmdletCorrectly',
31+
'PSUseOutputTypeCorrectly',
32+
'PSAvoidGlobalVars',
33+
'PSAvoidUsingConvertToSecureStringWithPlainText',
34+
'PSAvoidUsingPlainTextForPassword',
35+
'PSAvoidUsingUsernameAndPasswordParams',
36+
'PSDSCUseVerboseMessageInDSCResource',
37+
'PSShouldProcess',
38+
'PSUseDeclaredVarsMoreThanAssignments',
39+
'PSUsePSCredentialType',
40+
41+
'Measure-*'
42+
)
43+
44+
}

0 commit comments

Comments
 (0)