Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

xWebSiteDefaults: Should be made to follow the best practice for single instance resource #457

Closed
johlju opened this issue Sep 29, 2019 · 0 comments · Fixed by #527
Closed

xWebSiteDefaults: Should be made to follow the best practice for single instance resource #457

johlju opened this issue Sep 29, 2019 · 0 comments · Fixed by #527
Labels
breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/

Comments

@johlju
Copy link
Member

johlju commented Sep 29, 2019

The resource should be changed to follow the best practices to make single instance resource. This would change the property name of the key property. This is a breaking change.

https://docs.microsoft.com/en-us/powershell/dsc/resources/singleinstance
@johlju johlju added breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/ help wanted The issue is up for grabs for anyone in the community. in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Sep 29, 2019
@johlju johlju mentioned this issue Oct 3, 2019
Closed
RandomNoun7 added a commit to RandomNoun7/xWebAdministration that referenced this issue Oct 6, 2019
@RandomNoun7
BREAKING CHANGE: xWebSiteDefaults: Align to best practices for single…
ce83e94 
… instance resource

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.
RandomNoun7 added a commit to RandomNoun7/xWebAdministration that referenced this issue Oct 6, 2019
@RandomNoun7
BREAKING CHANGE: xWebSiteDefaults: Align to best practices
effdccf 
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.
RandomNoun7 added a commit to RandomNoun7/xWebAdministration that referenced this issue Oct 6, 2019
@RandomNoun7
BREAKING CHANGE: xWebSiteDefaults: Align to best practices
b7e67b6 
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.
@RandomNoun7 RandomNoun7 mentioned this issue Oct 6, 2019
Merged
RandomNoun7 added a commit to RandomNoun7/xWebAdministration that referenced this issue Oct 7, 2019
@RandomNoun7
BREAKING CHANGE: xWebSiteDefaults: Align to best practices
67c52d4 
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.
johlju pushed a commit that referenced this issue Oct 7, 2019
@RandomNoun7 @johlju
BREAKING CHANGE: xWebSiteDefaults: Align to best practices (#527)
0e06302 
- Changes to xWebSiteDefaults
  - BREAKING CHANGE: Changed `ApplyTo` key parameter to `IsSingleInstance` to
    bring the resource into compliance with published best practices (issue #457).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Oct 7, 2019
gstorme pushed a commit to gstorme/xWebAdministration that referenced this issue Feb 14, 2020
@RandomNoun7
BREAKING CHANGE: xWebSiteDefaults: Align to best practices (dsccommun…
2754e6c 
…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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
breaking change When used on an issue, the issue has been determined to be a breaking change. enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub hacktoberfest See https://hacktoberfest.digitalocean.com/
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

BREAKING CHANGE: xWebSiteDefaults: Align to best practices RandomNoun7/xWebAdministration
1 participant
@johlju