Skip to content

Commit 3bcfc23

Browse files
authored
Fix and Update Pipeline files to latest pattern (#67)
1 parent 076ab61 commit 3bcfc23

11 files changed

+241
-116
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
If you'd like to contribute to this project, please review the [Contribution Guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md).
1+
# Contributing
2+
3+
Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).

.github/ISSUE_TEMPLATE/Problem_with_resource.md

Lines changed: 0 additions & 57 deletions
This file was deleted.
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: FileContentDsc version
78+
description: |
79+
Please provide the version of the FileContentDsc 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 'FileContentDsc' -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.md

Lines changed: 0 additions & 21 deletions
This file was deleted.
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: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,29 @@
1111
You may remove this comment block, and the other comment blocks, but please
1212
keep the headers and the task list.
1313
-->
14+
1415
#### Pull Request (PR) description
16+
1517
<!--
1618
Replace this comment block with a description of your PR.
19+
Also, make sure you have updated the CHANGELOG.md, see the
20+
task list below. An entry in the CHANGELOG.md is mandatory
21+
for all PRs.
1722
-->
1823

1924
#### This Pull Request (PR) fixes the following issues
25+
2026
<!--
2127
If this PR does not fix an open issue, replace this comment block with None.
2228
If this PR resolves one or more open issues, replace this comment block with
23-
a list the issues using a GitHub closing keyword, e.g.:
24-
- Fixes #123
25-
- Fixes #124
29+
a list of the issues using a GitHub closing keyword, e.g.:
30+
31+
- Fixes #123
32+
- Fixes #124
2633
-->
2734

2835
#### Task list
36+
2937
<!--
3038
To aid community reviewers in reviewing and merging your PR, please take
3139
the time to run through the below checklist and make sure your PR has
@@ -34,14 +42,17 @@
3442
Change to [x] for each task in the task list that applies to your PR.
3543
For those task that don't apply to you PR, leave those as is.
3644
-->
37-
- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
38-
Entry should say what was changed, and how that affects users (if applicable).
39-
- [ ] Resource documentation added/updated in README.md in resource folder.
40-
- [ ] Resource parameter descriptions added/updated in schema.mof
45+
46+
- [ ] Added an entry to the change log under the Unreleased section of the
47+
file CHANGELOG.md. Entry should say what was changed and how that
48+
affects users (if applicable), and reference the issue being resolved
49+
(if applicable).
50+
- [ ] Resource documentation added/updated in README.md.
51+
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
4152
and comment-based help.
4253
- [ ] Comment-based help added/updated.
4354
- [ ] Localization strings added/updated in all localization files as appropriate.
4455
- [ ] Examples appropriately added/updated.
45-
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
46-
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
47-
- [ ] 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).
56+
- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
57+
- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
58+
- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2727
- Updated build to use `Sampler.GitHubTasks` - Fixes [Issue #60](https://github.com/dsccommunity/FileContentDsc/issues/60).
2828
- Added support for publishing code coverage to `CodeCov.io` and
2929
Azure Pipelines - Fixes [Issue #61](https://github.com/dsccommunity/FileContentDsc/issues/61).
30+
- Updated .github issue templates to standard - Fixes [Issue #64](https://github.com/dsccommunity/FileContentDsc/issues/64).
31+
- Added Create_ChangeLog_GitHub_PR task to publish stage of build pipeline.
32+
- Added SECURITY.md.
33+
- Updated pipeline Deploy_Module anb Code_Coverage jobs to use ubuntu-latest
34+
images - Fixes [Issue #63](https://github.com/dsccommunity/FileContentDsc/issues/63).
35+
- Updated pipeline unit tests and integration tests to use Windows Server 2019 and
36+
Windows Server 2022 images - Fixes [Issue #63](https://github.com/dsccommunity/FileContentDsc/issues/63).
37+
38+
### Fixed
39+
40+
- Fixed pipeline by replacing the GitVersion task in the `azure-pipelines.yml`
41+
with a script.
3042

3143
## [1.3.0.151] - 2019-07-20
3244

SECURITY.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Security
2+
3+
The DSC Community takes the security of our modules seriously, which includes all source code repositories managed through our GitHub organization.
4+
5+
If you believe you have found a security vulnerability in any DSC Community owned repository, please report it to us as described below.
6+
7+
## Reporting Security Issues
8+
9+
**Please do not report security vulnerabilities through public GitHub issues.**
10+
11+
Instead, please report them to one or several members of the DSC Community organization.
12+
The easiest way to do so is to send us a direct message via twitter or slack.
13+
14+
You should receive a response within 48 hours. If for some reason you do not, please follow up to other member of the community.
15+
16+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
17+
18+
* Type of issue
19+
* Full paths of source file(s) related to the manifestation of the issue
20+
* The location of the affected source code (tag/branch/commit or direct URL)
21+
* Any special configuration required to reproduce the issue
22+
* Step-by-step instructions to reproduce the issue
23+
* Proof-of-concept or exploit code (if possible)
24+
* Impact of the issue, including how an attacker might exploit the issue
25+
26+
This information will help us triage your report more quickly.
27+
28+
## Preferred Languages
29+
30+
We prefer all communications to be in English.

0 commit comments

Comments
 (0)