BREAKING CHANGE: xWebSiteDefaults: Align to best practices - #527
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #527 +/- ##
=======================================
Coverage 91.39% 91.39%
=======================================
Files 17 17
Lines 2661 2661
=======================================
Hits 2432 2432
Misses 229 229
Continue to review full report at Codecov.
|
johlju
added
needs review
johlju
left a comment
johlju
left a comment
There was a problem hiding this comment.
Reviewed 7 of 8 files at r1.
Reviewable status: 7 of 8 files reviewed, all discussions resolved
|
Waiting to merge another PR before this one (waiting for the tests to pass). That PR might affect the change log entry in this PR. |
|
@johlju Ok. Just ping me in a comment when ready and I'll rebase this one. |
|
@RandomNoun7 will be in just a few minutes. |
johlju
left a comment
johlju
left a comment
There was a problem hiding this comment.
Ready to rebase! 😃
Reviewed 1 of 8 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @RandomNoun7)
CHANGELOG.md, line 54 at r1 (raw file):
Changes to xWebSiteDefaults
When you rebase there will be an - Changes to xWebSiteDefaults where this entry can go under.
johlju
added
waiting for code fix
This change brings the modules xWebSiteDefaults resource into alignment with best practices for single instance resources. When defining a resource that should only be allowed to be defined once in any configuration, there are now best practices for how to implement that restriction. There should be a single key property and its name should be 'IsSingleInstance' with a value of 'Yes'. This change implements that best practice. Fixes dsccommunity#457 [x] Added an entry to the change log under the Unreleased section of the CHANGELOG.md. Entry should say what was changed and how that affects users (if applicable), and reference the issue being resolved (if applicable). [x] Resource documentation added/updated in README.md. [x] 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. [x] Examples appropriately added/updated. [ ] Unit tests added/updated. See DSC Resource Testing Guidelines. [x] Integration tests added/updated (where possible). See DSC Resource Testing Guidelines. [x] New/changed code adheres to DSC Resource Style Guidelines and Best Practices.
b7e67b6 to
67c52d4
Compare
|
@johlju Rebase complete and pushed. |
johlju
left a comment
johlju
left a comment
There was a problem hiding this comment.
Reviewed 3 of 3 files at r2.
Reviewable status:complete! all files reviewed, all discussions resolved
johlju
added
ready for merge
|
Closing and reopening to kick off the tests. CI failed on unrelated issue. |
johlju
removed
the
ready for merge
…ity#527) - Changes to xWebSiteDefaults - BREAKING CHANGE: Changed `ApplyTo` key parameter to `IsSingleInstance` to bring the resource into compliance with published best practices (issue dsccommunity#457).
3 participants
This change brings the modules xWebSiteDefaults resource into
alignment with best practices for single instance resources.
When defining a resource that should only be allowed to be defined once
in any configuration, there are now best practices for how to implement
that restriction. There should be a single key property and its name
should be 'IsSingleInstance' with a value of 'Yes'. This change
implements that best practice.
Fixes #457
[x] Added an entry to the change log under the Unreleased section of the CHANGELOG.md.
Entry should say what was changed and how that affects users (if applicable), and
reference the issue being resolved (if applicable).
[x] Resource documentation added/updated in README.md.
[x] 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.
[x] Examples appropriately added/updated.
[ ] Unit tests added/updated. See DSC Resource Testing Guidelines.
[x] Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
[x] New/changed code adheres to DSC Resource Style Guidelines and Best Practices.
This change is