Skip to content

Commit 72f33a9

Browse files
committed
Cleaned up to prepare for release to PSGallery
1 parent 0ea5afc commit 72f33a9

36 files changed

Lines changed: 182 additions & 99 deletions

.MetaTestOptIn.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
[
22
"Common Tests - Validate Markdown Files",
3-
"Common Tests - Validate Example Files"
3+
"Common Tests - Validate Example Files",
4+
"Common Tests - Validate Module Files",
5+
"Common Tests - Validate Script Files"
46
]

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
If you'd like to contribute to this project, please review the [Contribution Guidelines](https://github.com/PowerShell/DscResources/blob/master/CONTRIBUTING.md).

.github/ISSUE_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!--
2+
Your feedback and support is greatly appreciated, thanks for contributing!
3+
4+
Please prefix the issue title with the resource name, i.e. 'IniSettingsFile: Short description of my issue'
5+
Please provide the following information regarding your issue (place N/A if the fields that don't apply to your issue):
6+
-->
7+
**Details of the scenario you tried and the problem that is occurring:**
8+
9+
**The DSC configuration that is using the resource (as detailed as possible):**
10+
11+
**Version of the Operating System and PowerShell the DSC Target Node is running:**
12+
13+
**Version of the DSC module you're using, or 'dev' if you're using current dev branch:**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project is greatly appreciated!
3+
4+
Please prefix the PR title with the resource name, i.e. 'IniSettingsFile: My short description'
5+
If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:', i.e. 'BREAKING CHANGE: IniSettingsFile: My short description'
6+
7+
To aid community reviewers in reviewing and merging your PR, please take the time to run through the below checklist.
8+
Change to [x] for each task in the task list that applies to this PR.
9+
-->
10+
**Pull Request (PR) description**
11+
<!-- Replace this with a description of your pull request -->
12+
13+
**This Pull Request (PR) fixes the following issues:**
14+
<!-- Replace this with the list of issues or n/a. Use format: Fixes #123 -->
15+
16+
**Task list:**
17+
- [ ] Change details added to Unreleased section of CHANGELOG.md?
18+
- [ ] Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate?
19+
- [ ] Examples appropriately updated?
20+
- [ ] New/changed code adheres to [Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)?
21+
- [ ] [Unit and (optional) Integration tests](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md) created/updated where possible?

.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": true,
8+
"MD034": true,
9+
"no-hard-tabs": true
10+
}

.vscode/RunAllTests.ps1

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
[string] $repoRoot = Split-Path -Path (Split-Path -Path $Script:MyInvocation.MyCommand.Path)
22
if ( (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests'))) -or `
3-
(-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
3+
(-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
44
{
5-
& git @('clone', 'https://github.com/PowerShell/DscResource.Tests.git', (Join-Path -Path $repoRoot -ChildPath '\DSCResource.Tests\'))
5+
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $repoRoot -ChildPath 'Modules\FileContentDsc\DSCResource.Tests\'))
66
}
77

8-
Import-Module (Join-Path $PSScriptRoot "..\Tests\TestHarness.psm1" -Resolve)
9-
$dscTestsPath = Join-Path -Path $PSScriptRoot `
10-
-ChildPath "..\Modules\FileContentDsc\DscResource.Tests\Meta.Tests.ps1"
8+
Import-Module (Join-Path -Path $repoRoot -ChildPath 'Tests\TestHarness.psm1' -Resolve)
9+
$dscTestsPath = Join-Path -Path $repoRoot -ChildPath 'Modules\FileContentDsc\DscResource.Tests\Meta.Tests.ps1'
1110
Invoke-TestHarness -DscTestsPath $dscTestsPath

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Unreleased
44

5-
- MSFT_ReplaceText:
5+
- DSR_ReplaceText:
66
- Created new resource for replacing text in text files.
7-
- MSFT_KeyValuePairFile:
7+
- DSR_KeyValuePairFile:
88
- Created new resource for setting key value pairs in text files.
9-
- MSFT_IniSettingsFile:
9+
- DSR_IniSettingsFile:
1010
- Created new resource for setting Windows INI file settings.

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2017 Microsoft Corporation.
3+
Copyright (c) 2017 Daniel Scott-Raynsford.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
21+
THE SOFTWARE.

Modules/FileContentDsc/DSCResources/MSFT_IniSettingsFile/MSFT_IniSettingsFile.psm1 renamed to Modules/FileContentDsc/DSCResources/DSR_IniSettingsFile/DSR_IniSettingsFile.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Import-Module -Name (Join-Path -Path $modulePath `
1919

2020
# Import Localization Strings
2121
$localizedData = Get-LocalizedData `
22-
-ResourceName 'MSFT_IniSettingsFile' `
22+
-ResourceName 'DSR_IniSettingsFile' `
2323
-ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)
2424

2525
<#

Modules/FileContentDsc/DSCResources/MSFT_IniSettingsFile/MSFT_IniSettingsFile.schema.mof renamed to Modules/FileContentDsc/DSCResources/DSR_IniSettingsFile/DSR_IniSettingsFile.schema.mof

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[ClassVersion("1.0.0.0"), FriendlyName("IniSettingsFile")]
2-
class MSFT_IniSettingsFile : OMI_BaseResource
2+
class DSR_IniSettingsFile : OMI_BaseResource
33
{
44
[Key, Description("The path to the INI settings file to set the entry in.")] String Path;
55
[Key, Description("The section to add or set the entry in.")] String Section;
66
[Key, Description("The name of the key to add or set in the section.")] String Key;
77
[Write, Description("Specifies the value type that contains the value to set the entry to. Defaults to 'Text'."),ValueMap{"Text", "Secret"},Values{"Text", "Secret"}] String Type;
88
[Write, Description("The text to set the entry value to. Only used when Type is set to 'Text'.")] String Text;
9-
[write, Description("The secret text to set the entry value to. Only used when Type is set to 'Secret'."),EmbeddedInstance("MSFT_Credential")] String Secret;
9+
[write, Description("The secret text to set the entry value to. Only used when Type is set to 'Secret'."),EmbeddedInstance("DSR_Credential")] String Secret;
1010
};

0 commit comments

Comments
 (0)