SqlServerDsc: Deprecating SqlServerNetwork (#1544)

CHANGELOG.md

@@ -5,11 +5,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Removed
+### Deprecated
 
-- SqlServerDsc
-  - BREAKING CHANGE: Removed resource _SqlServerNetwork_. The functionality
-    is now covered by the resources _SqlServerProtocol_ and _SqlServerProtocolTcpIp_.
+The documentation, examples, unit test, and integration tests have been
+removed for these deprecated resources.
+
+- SqlServerNetwork
+  - This resource is now deprecated. The functionality is now covered by
+    the resources _SqlServerProtocol_ and _SqlServerProtocolTcpIp_.
 
 ### Added
 
@@ -38,6 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - SqlServerDsc
   - Changed all resource prefixes from `MSFT_` to `DSC_` ([issue #1496](https://github.com/dsccommunity/SqlServerDsc/issues/1496)).
+    _Deprecated resource has not changed prefix._
   - All resources are now using the common module DscResource.Common.
   - When a PR is labelled with 'ready for merge' it is no longer being
     marked as stale if the PR is not merged for 30 days (for example it is

README.md

@@ -65,6 +65,14 @@ for some general use scenarios for all of the resources that are in the module.
 
 A full list of changes in each version can be found in the [change log](CHANGELOG.md).
 
+### Deprecated resources
+
+The documentation, examples, unit test, and integration tests have been removed
+for these deprecated resources.
+
+* SqlServerNetwork _(replaced by [**SqlServerProtocol**](#sqlserverprotocol) and_
+  _[**SqlServerProtocolTcpIp**](#sqlserverprotocoltcpip))_.
+
 ## Resources
 
 * [**SqlAG**](#sqlag)

build.yaml

@@ -59,6 +59,8 @@ Pester:
   OutputFormat: NUnitXML
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
+    # Deprecated resources
+    - source/DSCResources/MSFT_SqlServerNetwork
   Script:
     - tests/Unit
   ExcludeTag:
@@ -73,8 +75,12 @@ DscTest:
   Tag:
   ExcludeSourceFile:
     - output
+    # Deprecated resources
+    - source/DSCResources/MSFT_SqlServerNetwork
   ExcludeModuleFile:
     - Modules/DscResource.Common
+    # Deprecated resources
+    - DSCResources/MSFT_SqlServerNetwork
 
 Resolve-Dependency:
   Gallery: 'PSGallery'

codecov.yml

@@ -26,3 +26,7 @@ coverage:
 
 fixes:
   - '\d+\.\d+\.\d+\/::source/'  # move path "X.Y.Z/" => "source/"
+
+# Deprecated resources
+ignore:
+  - 'source/DSCResources/MSFT_SqlServerNetwork'