Skip to content

Commit

Permalink
Fix and Update Pipeline files to latest pattern (#266)
Browse files Browse the repository at this point in the history
  • Loading branch information
PlagueHO authored Apr 15, 2022
1 parent 7aa733b commit b3b80c8
Show file tree
Hide file tree
Showing 11 changed files with 240 additions and 118 deletions.
4 changes: 3 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
If you'd like to contribute to this project, please review the [Contribution Guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md).
# Contributing

Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
57 changes: 0 additions & 57 deletions .github/ISSUE_TEMPLATE/Problem_with_resource.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/Problem_with_resource.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Problem with a resource
description: If you have a problem, bug, or enhancement with a resource in this resource module.
labels: []
assignees: []
body:
- type: markdown
attributes:
value: |
Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
Your feedback and support is greatly appreciated, thanks for contributing!
- type: textarea
id: description
attributes:
label: Problem description
description: Details of the scenario you tried and the problem that is occurring.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Verbose logs
description: |
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
placeholder: |
Paste verbose logs here
render: text
validations:
required: true
- type: textarea
id: configuration
attributes:
label: DSC configuration
description: |
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._
placeholder: |
Paste DSC configuration here
render: powershell
validations:
required: true
- type: textarea
id: suggestedSolution
attributes:
label: Suggested solution
description: Do you have any suggestions how to solve the issue?
validations:
required: true
- type: textarea
id: targetNodeOS
attributes:
label: Operating system the target node is running
description: |
Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
placeholder: |
Add operating system information here
render: text
validations:
required: true
- type: textarea
id: targetNodePS
attributes:
label: PowerShell version and build the target node is running
description: |
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
To help with this information, please run this command: `$PSVersionTable`
placeholder: |
Add PowerShell information here
render: text
validations:
required: true
- type: textarea
id: moduleVersion
attributes:
label: StorageDsc version
description: |
Please provide the version of the StorageDsc module that was used. _Will be automatically formatted as plain text._
To help with this information, please run this command: `Get-Module -Name 'StorageDsc' -ListAvailable | ft Name,Version,Path`
placeholder: |
Add module information here
render: text
validations:
required: true
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/Resource_proposal.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/Resource_proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: New resource proposal
description: If you have a new resource proposal that you think should be added to this resource module.
title: "NewResourceName: New resource proposal"
labels: []
assignees: []
body:
- type: markdown
attributes:
value: |
Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
Thank you for contributing and making this resource module better!
- type: textarea
id: description
attributes:
label: Resource proposal
description: Provide information how this resource will/should work and how it will help users.
validations:
required: true
- type: textarea
id: proposedProperties
attributes:
label: Proposed properties
description: |
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.
value: |
Property | Type qualifier | Data type | Description | Default value | Allowed values
--- | --- | --- | --- | --- | ---
PropertyName | Key | String | Detailed description | None | None
validations:
required: true
- type: textarea
id: considerations
attributes:
label: Special considerations or limitations
description: |
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.
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: "Virtual PowerShell User Group #DSC channel"
url: https://dsccommunity.org/community/contact/
about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."

31 changes: 21 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,29 @@
You may remove this comment block, and the other comment blocks, but please
keep the headers and the task list.
-->

#### Pull Request (PR) description

<!--
Replace this comment block with a description of your PR.
Also, make sure you have updated the CHANGELOG.md, see the
task list below. An entry in the CHANGELOG.md is mandatory
for all PRs.
-->

#### This Pull Request (PR) fixes the following issues

<!--
If this PR does not fix an open issue, replace this comment block with None.
If this PR resolves one or more open issues, replace this comment block with
a list the issues using a GitHub closing keyword, e.g.:
- Fixes #123
- Fixes #124
a list of the issues using a GitHub closing keyword, e.g.:
- Fixes #123
- Fixes #124
-->

#### Task list

<!--
To aid community reviewers in reviewing and merging your PR, please take
the time to run through the below checklist and make sure your PR has
Expand All @@ -34,14 +42,17 @@
Change to [x] for each task in the task list that applies to your PR.
For those task that don't apply to you PR, leave those as is.
-->
- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
Entry should say what was changed, and how that affects users (if applicable).
- [ ] Resource documentation added/updated in README.md in the resource folder.
- [ ] Resource parameter descriptions added/updated in schema.mof

- [ ] Added an entry to the change log under the Unreleased section of the
file CHANGELOG.md. Entry should say what was changed and how that
affects users (if applicable), and reference the issue being resolved
(if applicable).
- [ ] Resource documentation added/updated in README.md.
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
and comment-based help.
- [ ] Comment-based help added/updated.
- [ ] Localization strings added/updated in all localization files as appropriate.
- [ ] Examples appropriately added/updated.
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
- [ ] 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).
- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Azure Pipelines - Fixes [Issue #255](https://github.com/dsccommunity/StorageDsc/issues/255).
- Updated build to use `Sampler.GitHubTasks` - Fixes [Issue #254](https://github.com/dsccommunity/StorageDsc/issues/254).
- Updated pipeline tasks to latest pattern.
- Updated .github issue templates to standard - Fixes [Issue #263](https://github.com/dsccommunity/StorageDsc/issues/263).
- Added Create_ChangeLog_GitHub_PR task to publish stage of build pipeline.
- Added SECURITY.md.
- Updated pipeline Deploy_Module anb Code_Coverage jobs to use ubuntu-latest
images - Fixes [Issue #262](https://github.com/dsccommunity/StorageDsc/issues/262).
- Updated pipeline unit tests and integration tests to use Windows Server 2019 and
Windows Server 2022 images - Fixes [Issue #262](https://github.com/dsccommunity/StorageDsc/issues/262).

### Fixed

- MountImage:
- Corrected example `1-MountImage_DismountISO.ps1` for dismounting
ISO - Fixes [Issue #221](https://github.com/dsccommunity/StorageDsc/issues/221).
- Updated `GitVersion.yml` to latest pattern - Fixes [Issue #252](https://github.com/dsccommunity/StorageDsc/issues/252).
- Fixed pipeline by replacing the GitVersion task in the `azure-pipelines.yml`
with a script.

## [5.0.1] - 2020-08-03

Expand Down
30 changes: 30 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Security

The DSC Community takes the security of our modules seriously, which includes all source code repositories managed through our GitHub organization.

If you believe you have found a security vulnerability in any DSC Community owned repository, please report it to us as described below.

## Reporting Security Issues

**Please do not report security vulnerabilities through public GitHub issues.**

Instead, please report them to one or several members of the DSC Community organization.
The easiest way to do so is to send us a direct message via twitter or slack.

You should receive a response within 48 hours. If for some reason you do not, please follow up to other member of the community.

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:

* Type of issue
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue

This information will help us triage your report more quickly.

## Preferred Languages

We prefer all communications to be in English.
Loading

0 comments on commit b3b80c8

Please sign in to comment.