Skip to content

Commit

Permalink
SqlServerDsc: Latest pipeline files and GitHub templates (#1711)
Browse files Browse the repository at this point in the history
- SqlServerDsc
  - Updated pipelines files to latest from Sampler project.
  - Updated GitHub issue templates.
  • Loading branch information
johlju authored Aug 1, 2021
1 parent ddc86c3 commit 96edad6
Show file tree
Hide file tree
Showing 16 changed files with 756 additions and 387 deletions.
73 changes: 0 additions & 73 deletions .github/ISSUE_TEMPLATE/Problem_with_resource.md

This file was deleted.

112 changes: 112 additions & 0 deletions .github/ISSUE_TEMPLATE/Problem_with_resource.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
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: targetSqlEdition
attributes:
label: SQL Server edition and version
description: |
Please provide edition and version information of the Microsoft SQL Server the target node is running. _Will be automatically formatted as plain text._
To help with this information, please run this command in SQL: `select @@version`
placeholder: |
Add Microsoft SQL Server information here
render: text
validations:
required: true
- type: textarea
id: targetNodeSqlModule
attributes:
label: SQL Server PowerShell modules
description: |
Please provide the version of SQL Server PowerShell modules used by the target node. _Will be automatically formatted as plain text._
To help with this information, please run this command: `Get-Module -Name '*sql*' -ListAvailable | ? Name -ne 'SqlServerDsc' | ft Name,Version,Path`
placeholder: |
Add SQL Server PowerShell modules information here
render: text
validations:
required: true
- type: textarea
id: targetNodeOS
attributes:
label: Operating system
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
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: SqlServerDsc version
description: |
Please provide the version of the SqlServerDsc module that was used. _Will be automatically formatted as plain text._
To help with this information, please run this command: `Get-Module -Name 'SqlServerDsc' -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."

7 changes: 5 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
"powershell.codeFormatting.preset": "Custom",
"powershell.codeFormatting.alignPropertyValuePairs": true,
"powershell.codeFormatting.useConstantStrings": true,
"files.trimTrailingWhitespace": true,
"files.insertFinalNewline": true,
"powershell.developer.bundledModulesPath": "${cwd}/output/RequiredModules",
"powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
"powershell.scriptAnalysis.enable": true,
"files.trimTrailingWhitespace": true,
"files.trimFinalNewlines": true,
"files.insertFinalNewline": true,
"files.associations": {
"*.ps1xml": "xml"
},
Expand All @@ -34,6 +36,7 @@
"steppable"
],
"[markdown]": {
"files.trimTrailingWhitespace": true,
"files.encoding": "utf8"
}
}
2 changes: 1 addition & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"label": "build",
"type": "shell",
"command": "&${cwd}/build.ps1",
"args": ["-AutoRestore"],
"args": [],
"presentation": {
"echo": true,
"reveal": "always",
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
version of the Sampler module.
- Updated pipeline configuration to align with the latest changes in [Sampler](https://github.com/gaelcolas/Sampler).
- Update codecov.yml to support carry forward flags.
- Updated pipelines files to latest from Sampler project.
- Updated GitHub issue templates.
- SqlSetup
- The helper function `Connect-SqlAnalysis` was using `LoadWithPartial()`
to load the assembly _Microsoft.AnalysisServices_. On a node where multiple
Expand Down
10 changes: 5 additions & 5 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The MIT License (MIT)
MIT License

Copyright (c) DSC Community contributors.

Expand All @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ configuration of Microsoft SQL Server.

[![Build Status](https://dev.azure.com/dsccommunity/SqlServerDsc/_apis/build/status/dsccommunity.SqlServerDsc?branchName=main)](https://dev.azure.com/dsccommunity/SqlServerDsc/_build/latest?definitionId=11&branchName=main)
![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/SqlServerDsc/11/main)
[![codecov](https://codecov.io/gh/dsccommunity/SqlServerDsc/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/SqlServerDsc)
[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/SqlServerDsc/11/main)](https://dsccommunity.visualstudio.com/SqlServerDsc/_test/analytics?definitionId=11&contextType=build)
[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/SqlServerDsc?label=SqlServerDsc%20Preview)](https://www.powershellgallery.com/packages/SqlServerDsc/)
[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/SqlServerDsc?label=SqlServerDsc)](https://www.powershellgallery.com/packages/SqlServerDsc/)
Expand Down Expand Up @@ -32,7 +33,7 @@ A full list of changes in each version can be found in the [change log](CHANGELO

## Documentation

The documentation can be found in the [SqlServeDsc Wiki](https://github.com/dsccommunity/SqlServerDsc/wiki).
The documentation can be found in the [SqlServerDsc Wiki](https://github.com/dsccommunity/SqlServerDsc/wiki).
The DSC resources schema files is used to automatically update the
documentation on each PR merge.

Expand All @@ -41,4 +42,4 @@ documentation on each PR merge.
You can review the [Examples](/source/Examples) directory in the SqlServerDsc module
for some general use scenarios for all of the resources that are in the module.

The resource examples are also available in the [SqlServeDsc Wiki](https://github.com/dsccommunity/SqlServerDsc/wiki).
The resource examples are also available in the [SqlServerDsc Wiki](https://github.com/dsccommunity/SqlServerDsc/wiki).
5 changes: 2 additions & 3 deletions RequiredModules.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
AddToPath = $true
Target = 'output\RequiredModules'
Parameters = @{
Repository = ''
Repository = 'PSGallery'
}
}

Expand All @@ -16,11 +16,11 @@
Sampler = 'latest'
'Sampler.GitHubTasks' = 'latest'
MarkdownLinkCheck = 'latest'
'DscResource.Common' = 'latest'
'DscResource.Test' = 'latest'
'DscResource.AnalyzerRules' = 'latest'
xDscResourceDesigner = 'latest'
'DscResource.DocGenerator' = 'latest'
'DscResource.Common' = 'latest'

# Dependency for integration tests
LoopbackAdapter = 'latest'
Expand All @@ -32,4 +32,3 @@
NetworkingDsc = '7.4.0.0'
PowerShellGet = '2.1.2'
}

Loading

0 comments on commit 96edad6

Please sign in to comment.