Changelog for FailOverClusterDsc

July 6, 2025 ยท View on GitHub

The format is based on and uses the types of changes according to Keep a Changelog, and this project adheres to Semantic Versioning.

For older change log history see the historic changelog.

[Unreleased]

Changed

  • azure-pipelines.yml
    • Remove windows 2019 image fixes #294.
  • Migrate tests to Pester 5.
  • Updated to single stubs module.

Removed

  • Removed CommonTestHelper as functions are now provided by DscResource.Test.
  • Removed OS specific (mainly 2012R2) tests.

[2.2.0] - 2025-05-22

Fixed

  • Cluster
    • Fixed Get-TargetResource is reporting error when cluster is not found (issue #283).

Changed

  • FailoverClusterDsc
    • URLs in module manifest now points to the renamed repository.
    • Fixed build pipeline to use GitVersion v5.
    • Switch build pipeline to use windows-latest as the build agent.
    • Update latest module files from Sampler.
    • Use matrix pipeline strategy.
    • Try using CodeCov CLI
    • Update CodeCov CLI command
    • Use CodeCov upload-process

[2.1.0] - 2022-06-19

Added

  • New Resource
    • ClusterIPAddress
      • Adds an IP address to the cluster.

Changed

  • Cluster
    • New parameter KeepDownedNodesInCluster controls whether or not to evict nodes in a down state from the cluster.
  • FailoverClusterDsc
    • Update pipeline files to the latest from the Sampler project.
    • Moved all documentation from the README.md to the GitHub repository Wiki. All the DSC resource's schema MOF files was updated with descriptions from the README.md where they were more descriptive.
    • Update GitHub pull request template after documentation was moved.
  • ClusterPreferredOwner
    • Minor fix to tests.

[2.0.0] - 2022-05-25

Changed

  • BREAKING CHANGE
    • Renamed xFailOverCluster to FailoverClusterDsc - fixes Issue #69.
    • Changed all MSFT_xResourceName to DSC_ResourceName.
    • Updated DSCResources, Examples, Modules and Tests for new naming.
    • Updated README.md from xFailOverCluster to FailoverClusterDsc

[1.16.1] - 2022-05-24

Deprecated

  • The module xFailOverCluster will be renamed to FailoverClusterDsc (issue #69). The version v1.6.1 will be the the last release of xFailOverCluster. The Version v2.0.0 will be released as FailoverClusterDsc, it will be released shortly after the v1.6.1 release to be able to start transition to the new module. The prefix 'x' will be removed from all resources in FailoverClusterDsc.

[1.16.0] - 2021-03-17

Added

  • xClusterProperty
    • Added the BlockCacheSize parameter which controls Cluster Shared Volume memory caching in MB (issue #252).

Changed

  • xFailOverCluster
    • Update pipeline to use new deploy tasks.

[1.15.0] - 2021-02-19

Added

  • xFailOverCluster
    • Add the module MarkdownLinkCheck to dependent modules to active the markdown link tests.
    • Added the filetypes to the file .gitattributes according to the Plaster template.
    • Update examples to be ready to be published to the PowerShell Gallery.
    • Added a CONTRIBUTING.md.
    • Replaced module CommonResourceHelper with the PowerShell Gallery module DscResource.Common v0.2.0.
    • Adding back publishing code coverage to Codecov.io.
      • Add status badge for Codecov.io in README.md.
      • Fix Azure Pipelines code coverage (issue #236).

Changed

  • xFailOverCluster
    • Renamed master branch to main (issue #246).
    • Updated the CI pipeline files to the latest template.
    • Changed unit tests to handle missing DscResource.Test better.
    • Changed the Code of Conduct to the one adopted by DSC Community.
    • Added .markdownlint.json to get the correct settings for the MarkdownLint VS Code extension.
    • Changed Visual Studio Code settings to the file settings.json according to the Plaster template.
    • Set testRunTitle for PublishTestResults task so that a helpful name is displayed in Azure DevOps for each test run.
    • Set a display name on all the jobs and tasks in the CI pipeline.
    • The deploy step is now only run when merged to branch master in the DSC Community upstream repository (not to branch master in a fork which always failed due to missing credentials).
    • Only run the CI pipeline on branch master when there are changes to files inside the source folder.
    • Changed integration tests to run on a a build image with Windows Server 2019 since the one we previously used was removed from Azure Pipelines (issue #233).
    • Updated CI pipeline to get version from the property NuGetVersionV2.
    • Pin Pester to 4.10.1 in RequiredModule.psd1 since the tests does not support Pester 5.
    • Updated repository to use the latest version of the module ModuleBuilder.

Fixed

  • xFailOverCluster
    • The component gitversion that is used in the pipeline was wrongly configured when the repository moved to the new default branch main. It no longer throws an error when using newer versions of GitVersion.
    • Added CODE_OF_CONDUCT.md file, and a 'Code of Conduct' section in the README.md.
    • Improved CI pipeline
      • Renamed the jobs
      • Splitting up the testing in different jobs.
    • URLs in the module manifest pointed in the wrong direction.
    • Changed the encoding that will be used by ModuleBuilder (UTF-8).
    • URLs to examples in README.md didn't take account for new folder structure.
    • Release pipeline stopped working in some circumstances, workaround is to pin ModuleBuilder to version 1.0.0 for now. There is an issue with ModuleBuilder with preview strings using dash, e.g. fix0008-9. The string is compliant with SemVer 2.0 but there is a bug in Publish-Module that prevents the module to be released.
    • Added code coverage reporting to Azure DevOps.
    • Update status badges in README.md.
    • Replaced section 'Branches' with section 'Releases' in README.md.
    • Pull request and issue template got minor updates.
    • Update module manifest exporting resources and fixed style.
    • Update GitVersion.yml with the correct regular expression.
    • Fix import statement in all tests, making sure it throws if module DscResource.Test cannot be imported.
    • Update the deploy stage so that it is skipped when merging branch master in forks.
  • xClusterPreferredOwner
    • Fixed broken links to examples in README.md.
  • xClusterQuorum
    • Fixed broken link to examples in README.md (issue #208).
  • CommonResourceHelper
    • Added en-US localization folder to pass PSSA rule.
  • xCluster
    • Added script file information to the example 1-CreateFirstNodeOfAFailoverCluster.ps1.
    • Fixed Describe-block descriptions (issue #234).
    • Made DomainAdministratorCredential optional (issue #164)

Removed

  • Removed the file Deploy.PSDeploy.ps1 since it is not longer used by the build pipeline.

[1.14.1] - 2019-12-18

Changed

  • xFailOverCluster
    • Changed the pipeline to publish test results for both success and failure.

Fixed

  • CommonResourceHelper
    • Fix unit tests to load the helper modules using module manifest.
    • Fix to correctly export the functions in the helper module (issue #214).
    • Fix typo in module manifest.

[1.14.0] - 2019-12-17

Added

  • xFailOverCluster
    • Added automatic release with a new CI pipeline.

Changed

  • xFailOverCluster
    • Moved the helper module CommonResourceHelper to the Modules folder.
  • CommonResourceHelper
    • Update Get-LocalizedData to handle new location of helper module.