Releasing version 3.0.0.0

dsccommunity · Jun 26, 2019 · 993f2b8 · 993f2b8
1 parent 46634ed
commit 993f2b8
Show file tree

Hide file tree

Showing 2 changed files with 136 additions and 45 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+## 3.0.0.0
+
 - Changes to xActiveDirectory
   - Added new helper functions in xADCommon, see each functions comment-based
     help for more information.

diff --git a/xActiveDirectory.psd1 b/xActiveDirectory.psd1
@@ -1,6 +1,6 @@
 @{
 # Version number of this module.
-moduleVersion = '2.26.0.0'
+moduleVersion = '3.0.0.0'
 
 # ID used to uniquely identify this module
 GUID = '9FECD4F6-8F02-4707-99B3-539E940E9FF5'
@@ -50,54 +50,142 @@ PrivateData = @{
 
         # ReleaseNotes of this module
         ReleaseNotes = '- Changes to xActiveDirectory
-  - Added localization module -DscResource.LocalizationHelper* containing
-    the helper functions `Get-LocalizedData`, `New-InvalidArgumentException`,
-    `New-InvalidOperationException`, `New-ObjectNotFoundException`, and
-    `New-InvalidResultException` ([issue 257](https://github.com/PowerShell/xActiveDirectory/issues/257)).
-    For more information around these helper functions and localization
-    in resources, see [Localization section in the Style Guideline](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.mdlocalization).
-  - Added common module *DscResource.Common* containing the helper function
-    `Test-DscParameterState`. The goal is that all resource common functions
-    are moved to this module (functions that are or can be used by more
-    than one resource) ([issue 257](https://github.com/PowerShell/xActiveDirectory/issues/257)).
-  - Added xADManagedServiceAccount resource to manage Managed Service
-    Accounts (MSAs). [Andrew Wickham (@awickham10)](https://github.com/awickham10)
-    and [@kungfu71186](https://github.com/kungfu71186)
-  - Removing the Misc Folder, as it is no longer required.
-  - Added xADKDSKey resource to create KDS Root Keys for gMSAs. [@kungfu71186](https://github.com/kungfu71186)
-  - Combined DscResource.LocalizationHelper and DscResource.Common Modules into xActiveDirectory.Common
-- Changes to xADReplicationSiteLink
-  - Make use of the new localization helper functions.
-- Changes to xAdDomainController
-  - Added new parameter to disable or enable the Global Catalog (GC)
-    ([issue 75](https://github.com/PowerShell/xActiveDirectory/issues/75)). [Eric Foskett @Merto410](https://github.com/Merto410)
-  - Fixed a bug with the parameter `InstallationMediaPath` that it would
-    not be added if it was specified in a configuration. Now the parameter
-    `InstallationMediaPath` is correctly passed to `Install-ADDSDomainController`.
-  - Refactored the resource with major code cleanup and localization.
-  - Updated unit tests to latest unit test template and refactored the
-    tests for the function "Set-TargetResource".
-  - Improved test code coverage.
+  - Added new helper functions in xADCommon, see each functions comment-based
+    help for more information.
+    - Convert-PropertyMapToObjectProperties
+    - Compare-ResourcePropertyState
+    - Test-DscPropertyState
+  - Move the examples in the README.md to Examples folder.
+  - Fix Script Analyzer rule failures.
+  - Opt-in to the following DSC Resource Common Meta Tests:
+    - Common Tests - Custom Script Analyzer Rules
+    - Common Tests - Required Script Analyzer Rules
+    - Common Tests - Flagged Script Analyzer Rules
+    - Common Tests - Validate Module Files ([issue 282](https://github.com/PowerShell/xActiveDirectory/issues/282))
+    - Common Tests - Validate Script Files ([issue 283](https://github.com/PowerShell/xActiveDirectory/issues/283))
+    - Common Tests - Relative Path Length ([issue 284](https://github.com/PowerShell/xActiveDirectory/issues/284))
+    - Common Tests - Validate Markdown Links ([issue 280](https://github.com/PowerShell/xActiveDirectory/issues/280))
+    - Common Tests - Validate Localization ([issue 281](https://github.com/PowerShell/xActiveDirectory/issues/281))
+    - Common Tests - Validate Example Files ([issue 279](https://github.com/PowerShell/xActiveDirectory/issues/279))
+    - Common Tests - Validate Example Files To Be Published ([issue 311](https://github.com/PowerShell/xActiveDirectory/issues/311))
+  - Move resource descriptions to Wiki using auto-documentation ([issue 289](https://github.com/PowerShell/xActiveDirectory/issues/289))
+  - Move helper functions from MSFT_xADCommon to the module
+    xActiveDirectory.Common ([issue 288](https://github.com/PowerShell/xActiveDirectory/issues/288)).
+    - Removed helper function `Test-ADDomain` since it was not used. The
+      helper function had design flaws too.
+    - Now the helper function `Test-Members` outputs all the members that
+      are not in desired state when verbose output is enabled.
+  - Update all unit tests to latest unit test template.
+  - Deleted the obsolete xActiveDirectory_TechNetDocumentation.html file.
+  - Added new resource xADObjectEnabledState. This resource should be
+    used to enforce the `Enabled` property of computer accounts. This
+    resource replaces the deprecated `Enabled` property in the resource
+    xADComputer.
+  - Cleanup of code
+    - Removed semicolon throughout where it is not needed.
+    - Migrate tests to Pester syntax v4.x ([issue 322](https://github.com/PowerShell/xActiveDirectory/issues/322)).
+    - Removed `-MockWith {}` in unit tests.
+    - Use fully qualified type names for parameters and variables
+      ([issue 374](https://github.com/PowerShell/xActiveDirectory/issues/374)).
+  - Removed unused legacy test files from the root of the repository.
+  - Updated Example List README with missing resources.
+  - Added missing examples for xADReplicationSubnet, xADServicePrincipalName and xWaitForADDomain. ([issue 395](https://github.com/PowerShell/xActiveDirectory/issues/395)).
 - Changes to xADComputer
-  - Restoring a computer account from the recycle bin no longer fails if
-    there is more than one object with the same name in the recycle bin.
-    Now it uses the object that was changed last using the property
-    `whenChanged` ([issue 271](https://github.com/PowerShell/xActiveDirectory/issues/271)).
+  - Refactored the resource and the unit tests.
+  - BREAKING CHANGE: The `Enabled` property is **DEPRECATED** and is no
+    longer set or enforces with this resource. _If this parameter is_
+    _used in a configuration a warning message will be outputted saying_
+    _that the `Enabled` parameter has been deprecated_. The new resource
+    [xADObjectEnabledState](https://github.com/PowerShell/xActiveDirectoryxadobjectenabledstate)
+    can be used to enforce the `Enabled` property.
+  - BREAKING CHANGE: The default value of the enabled property of the
+    computer account will be set to the default value of the cmdlet
+    `New-ADComputer`.
+  - A new parameter was added called `EnabledOnCreation` that will control
+    if the computer account is created enabled or disabled.
+  - Moved examples from the README.md to separate example files in the
+    Examples folder.
+  - Fix the RestoreFromRecycleBin description.
+  - Fix unnecessary cast in `Test-TargetResource` ([issue 295](https://github.com/PowerShell/xActiveDirectory/issues/295)).
+  - Fix ServicePrincipalNames property empty string exception ([issue 382](https://github.com/PowerShell/xActiveDirectory/issues/382)).
 - Changes to xADGroup
-  - Restoring a group from the recycle bin no longer fails if there is
-    more than one object with the same name in the recycle bin. Now it
-    uses the object that was changed last using the property `whenChanged`
-    ([issue 271](https://github.com/PowerShell/xActiveDirectory/issues/271)).
+  - Change the description of the property RestoreFromRecycleBin.
+  - Code cleanup.
+- Changes to xADObjectPermissionEntry
+  - Change the description of the property IdentityReference.
+  - Fix failure when applied in the same configuration as xADDomain.
+  - Localize and Improve verbose messaging.
+  - Code cleanup.
 - Changes to xADOrganizationalUnit
-  - Restoring an organizational unit from the recycle bin no longer fails
-    if there is more than one object with the same name in the recycle bin.
-    Now it uses the object that was changed last using the property `whenChanged`
-    ([issue 271](https://github.com/PowerShell/xActiveDirectory/issues/271)).
+  - Change the description of the property RestoreFromRecycleBin.
+  - Code cleanup.
+  - Fix incorrect verbose message when this resource has Ensure set to Absent ([issue 276](https://github.com/PowerShell/xActiveDirectory/issues/276)).
 - Changes to xADUser
-  - Restoring a user from the recycle bin no longer fails if there is
-    more than one object with the same name in the recycle bin. Now it
-    uses the object that was changed last using the property `whenChanged`
-    ([issue 271](https://github.com/PowerShell/xActiveDirectory/issues/271)).
+  - Change the description of the property RestoreFromRecycleBin.
+  - Added ServicePrincipalNames property ([issue 153](https://github.com/PowerShell/xActiveDirectory/issues/153)).
+  - Added ChangePasswordAtLogon property ([issue 246](https://github.com/PowerShell/xActiveDirectory/issues/246)).
+  - Code cleanup.
+  - Added LogonWorkstations property
+  - Added Organization property
+  - Added OtherName property
+  - Added AccountNotDelegated property
+  - Added AllowReversiblePasswordEncryption property
+  - Added CompoundIdentitySupported property
+  - Added PasswordNotRequired property
+  - Added SmartcardLogonRequired property
+  - Added ProxyAddresses property ([Issue 254](https://github.com/PowerShell/xActiveDirectory/issues/254)).
+  - Fix Password property being updated whenever another property is changed
+    ([issue 384](https://github.com/PowerShell/xActiveDirectory/issues/384)).
+  - Replace Write-Error with the correct helper function ([Issue 331](https://github.com/PowerShell/xActiveDirectory/issues/331)).
+- Changes to xADDomainController
+  - Change the `Requires` statement in the Examples to require the correct
+    module.
+  - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
+    resource is using the `$global:DSCMachineStatus` variable to trigger
+    a reboot.
+  - Code cleanup.
+- Changes to xADDomain
+  - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
+    resource is using the `$global:DSCMachineStatus` variable to trigger
+    a reboot.
+  - Code cleanup.
+- Changes to xADDomainTrust
+  - Replaced New-TerminatingError with Standard Function.
+  - Code cleanup.
+- Changes to xWaitForADDomain
+  - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
+    resource is using the `$global:DSCMachineStatus` variable to trigger
+    a reboot.
+  - Added missing property schema descriptions ([issue 369](https://github.com/PowerShell/xActiveDirectory/issues/369)).
+  - Code cleanup.
+- Changes to xADRecycleBin
+  - Remove unneeded example and resource designer files.
+  - Added missing property schema descriptions ([issue 368](https://github.com/PowerShell/xActiveDirectory/issues/368)).
+  - Code cleanup.
+  - It now sets back the `$ErrorActionPreference` that was set prior to
+    setting it to `"Stop"`.
+  - Replace Write-Error with the correct helper function ([issue 327](https://github.com/PowerShell/xActiveDirectory/issues/327)).
+- Changes to xADReplicationSiteLink
+  - Fix ADIdentityNotFoundException when creating a new site link.
+  - Code cleanup.
+- Changes to xADReplicationSubnet
+  - Remove `{ *Present* | Absent }` from the property schema descriptions
+    which were causing corruption in the Wiki documentation.
+- Changes to xADServicePrincipalNames
+  - Remove `{ *Present* | Absent }` from the property schema descriptions
+    which were causing corruption in the Wiki documentation.
+- Changes to xADDomainDefaultPasswordPolicy
+  - Code cleanup.
+- Changes to xADForestProperties
+  - Minor style cleanup.
+- Changes to xADReplicationSubnet
+  - Code cleanup.
+- Changes to xADKDSKey
+  - Code cleanup.
+- Changes to xADManagedServiceAccount
+  - Code cleanup.
+- Changes to xADServicePrincipalName
+  - Code cleanup.
 
 '
 
@@ -121,3 +209,4 @@ PrivateData = @{
 
 
 
+