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.

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

BREAKING CHANGE: SqlDatabaseOwner/Permission/Role: Update parameter Database to DatabaseName #1507

Merged
merged 5 commits into from
Apr 25, 2020

Conversation

Rob-S
Copy link
Contributor

@Rob-S Rob-S commented Apr 21, 2020

Pull Request (PR) description

BREAKING CHANGE: Database changed to DatabaseName for consistency with other modules.

This Pull Request (PR) fixes the following issues

Task list

  • [✓] 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 Community Testing Guidelines.
  • Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
  • [✓] New/changed code adheres to DSC Community Style Guidelines.

This change is Reviewable

@johlju johlju added the needs review The pull request needs a code review. label Apr 21, 2020
Copy link
Member

@johlju johlju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 16 of 26 files at r1.
Reviewable status: 14 of 26 files reviewed, 4 unresolved discussions (waiting on @johlju and @Rob-S)


CHANGELOG.md, line 8 at r1 (raw file):

## [Unreleased]

There are duplicate Unreleased sections.


source/DSCResources/MSFT_SqlDatabaseRole/MSFT_SqlDatabaseRole.psm1, line 22 at r1 (raw file):

RoleName

Not sure we should change this from Name. I think since the resource is named SqlDatabaseRole then it is implicit that the Name means the role name. If community want to change this then we need to change a lot of resources since most follow this pattern.
I suggest renaming RoleName in this resource (only) back to Name (you may keep RoleName on the helper functions though).


source/Examples/Resources/SqlDatabaseUser/1-AddDatabaseUserWithLogin.ps1, line 25 at r1 (raw file):

UserName

This should be kept as Name, throughout this file and the other examples for this resource. Since the resource is named SqlDatabaseUser then it is implicit that the Name means the user name.


tests/Unit/MSFT_SqlDatabaseOwner.Tests.ps1, line 145 at r1 (raw file):

$result.Database

This should be DatabaseName. Throughout.

@johlju johlju self-requested a review April 21, 2020 17:44
@johlju johlju added waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. and removed needs review The pull request needs a code review. labels Apr 21, 2020
@johlju johlju added the breaking change When used on an issue, the issue has been determined to be a breaking change. label Apr 21, 2020
@johlju johlju changed the title SqlDatabaseOwner/Permission/Role - Issue1484 BREAKING CHANGE: SqlDatabaseOwner/Permission/Role: Update parameter Database to DatabaseName Apr 21, 2020
Copy link
Member

@johlju johlju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 13 of 17 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@johlju johlju added ready for merge The pull request was approved by the community and is ready to be merged by a maintainer. and removed breaking change When used on an issue, the issue has been determined to be a breaking change. waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. labels Apr 22, 2020
@johlju
Copy link
Member

johlju commented Apr 22, 2020

Awesome work on this. This looks great and I will merge soon. I waiting for more breaking changes PR's before I merge so we can release fixes.

I'm working on a breaking PR too but goes slow since I don't have much time at the moment.

@johlju johlju merged commit 8ec8095 into dsccommunity:master Apr 25, 2020
@johlju johlju removed the ready for merge The pull request was approved by the community and is ready to be merged by a maintainer. label Apr 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants