Deprecated the NuGet Packages (#20)

- Updated the package description with deprecation message - Updated the classes with Obsolete attribute
DFE-Digital · Oct 10, 2024 · dfd79c2 · dfd79c2
1 parent ea4fce6
commit dfd79c2
Show file tree

Hide file tree

Showing 25 changed files with 80 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,8 @@
+# Repository and Packages Deprecated
+
+>[!WARNING]
+>This repository/package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs instead.
+
 # Academisation Nuget Packages
 
 This repository is a mono-repo and contains a number of different Nuget packages used by the academisation process - A2B, Prepare Transfers and Prepare Conversions.

diff --git a/academiesContracts/Dfe.Academies.Contracts/Dfe.Academies.Contracts.csproj b/academiesContracts/Dfe.Academies.Contracts/Dfe.Academies.Contracts.csproj
@@ -11,9 +11,10 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/DFE-Digital/academisation-nuget-packages</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-	<Version>1.0.10</Version>
-	<AssemblyVersion>1.0.10</AssemblyVersion>
-	<FileVersion>1.0.10</FileVersion>
+	<Version>1.0.11</Version>
+	<AssemblyVersion>1.0.11</AssemblyVersion>
+	<FileVersion>1.0.11</FileVersion>
+	  <Description>This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.</Description>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/academiesContracts/Dfe.Academies.Contracts/README.md b/academiesContracts/Dfe.Academies.Contracts/README.md
@@ -1 +1 @@
-
+This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.
diff --git a/academiesContracts/Dfe.Academies.Contracts/V1/EducationalPerformance/SchoolAbsenceDataDto.cs b/academiesContracts/Dfe.Academies.Contracts/V1/EducationalPerformance/SchoolAbsenceDataDto.cs
@@ -3,6 +3,9 @@ namespace Dfe.Academies.Contracts.V1.EducationalPerformance
     /// <summary>
     /// Absence Data Response 
     /// </summary>
+#pragma warning disable S1133
+    [Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.")]
+#pragma warning restore S1133
     public class SchoolAbsenceDataDto
     {
         /// <summary>

diff --git a/academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs b/academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs
@@ -5,6 +5,9 @@
 using System.Text;
 using System.Threading.Tasks;
 
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.")]
+#pragma warning restore S1133
 [Serializable]
 public class AddressDto
 {

diff --git a/academiesContracts/Dfe.Academies.Contracts/V4/Establishments/EstablishmentDto.cs b/academiesContracts/Dfe.Academies.Contracts/V4/Establishments/EstablishmentDto.cs
@@ -1,6 +1,9 @@
 namespace Dfe.Academies.Contracts.V4.Establishments;
 
 [Serializable]
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.")]
+#pragma warning restore S1133
 public class EstablishmentDto
 {
 

diff --git a/academiesContracts/Dfe.Academies.Contracts/V4/PagedDataResponse.cs b/academiesContracts/Dfe.Academies.Contracts/V4/PagedDataResponse.cs
@@ -1,6 +1,9 @@
 namespace Dfe.Academies.Contracts.V4;
 using System.Collections.Generic;
 
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.")]
+#pragma warning restore S1133
 [Serializable]
 public class PagedDataResponse<TResponse> where TResponse : class
 {

diff --git a/academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs b/academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs
@@ -2,6 +2,9 @@
 
 using Dfe.Academies.Contracts.V4.Establishments;
 
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.")]
+#pragma warning restore S1133
 [Serializable]
 public class TrustDto
 {

diff --git a/correlationIdMiddleware/correlationIdMiddleware/CorrelationContext.cs b/correlationIdMiddleware/correlationIdMiddleware/CorrelationContext.cs
@@ -1,6 +1,9 @@
 namespace Dfe.Academisation.CorrelationIdMiddleware;
 
 /// <inheritdoc />
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.")]
+#pragma warning restore S1133
 public class CorrelationContext : ICorrelationContext
 {
     /// <inheritdoc />

diff --git a/correlationIdMiddleware/correlationIdMiddleware/CorrelationIdMiddleware.cs b/correlationIdMiddleware/correlationIdMiddleware/CorrelationIdMiddleware.cs
@@ -9,6 +9,9 @@
 /// Saves these values in the correlationContext instance. Be sure to register correlation context as scoped or the equivalent in you ioc container.
 /// Header used in requests is 'x-correlationId'
 /// </summary>
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.")]
+#pragma warning restore S1133
 public class CorrelationIdMiddleware
 {
     private readonly RequestDelegate _next;

diff --git a/...tionIdMiddleware/correlationIdMiddleware/Dfe.Academisation.CorrelationIdMiddleware.csproj b/...tionIdMiddleware/correlationIdMiddleware/Dfe.Academisation.CorrelationIdMiddleware.csproj
@@ -6,16 +6,16 @@
         <Nullable>enable</Nullable>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Title>Dfe Academisation Correlation Id Middleware</Title>
-        <Description>Asp.net middleware to read incoming request headers and set a correlationId which can then be used for logging and other requests/events.</Description>
         <PackageProjectUrl>https://github.com/DFE-Digital/academisation-nuget-packages/tree/main/correlationIdMiddleware</PackageProjectUrl>
         <RepositoryUrl>https://github.com/DFE-Digital/academisation-nuget-packages</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <PackageTags>dfe;academisation;correlation;</PackageTags>
         <UserSecretsId>4ac4e7ef-aaff-48a4-9e4d-44371c231191</UserSecretsId>
         <PackageReadmeFile>README.md</PackageReadmeFile>
-        <Version>2.0.2</Version>
+        <Version>2.0.3</Version>
         <Authors>DFE-Digital</Authors>
-    </PropertyGroup>
+	    <Description>This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.</Description>
+	</PropertyGroup>
 
     <ItemGroup>
       <None Include="..\README.md">

diff --git a/correlationIdMiddleware/correlationIdMiddleware/ICorrelationContext.cs b/correlationIdMiddleware/correlationIdMiddleware/ICorrelationContext.cs
@@ -4,6 +4,9 @@
 /// Provides access to the current correlation id. You should register this as a scoped / per web request
 /// dependency in your IoC/DI container.
 /// </summary>
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.")]
+#pragma warning restore S1133
 public interface ICorrelationContext
 {
     /// <summary>

diff --git a/correlationIdMiddleware/correlationIdMiddleware/Keys.cs b/correlationIdMiddleware/correlationIdMiddleware/Keys.cs
@@ -2,7 +2,9 @@
 /// <summary>
 /// The keys used by the correlation id middleware.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.")]
+#pragma warning restore S1133
 public class Keys
 {
     /// <summary>

diff --git a/correlationIdMiddleware/correlationIdMiddleware/README.md b/correlationIdMiddleware/correlationIdMiddleware/README.md
@@ -1,3 +1,8 @@
+# Deprecated
+
+This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.
+
+
 # Correlation ID Middleware
 
 ## What does this do ?

diff --git a/correlationIdMiddleware/correlationIdMiddleware/ReleaseNotes.md b/correlationIdMiddleware/correlationIdMiddleware/ReleaseNotes.md
@@ -1,3 +1,7 @@
+# 2.0.3
+
+This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Http instead.
+
 # 2.0.2
 Fixed passing in an empty GUID in the x-correlationId header causing an exception. Now if an empty GUID is detected a bad request will be returned.
 If an empty guid is returned, the content of the response returned (along with the 400 status code) will be 

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/BooleanExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/BooleanExtensions.cs
@@ -3,6 +3,9 @@
 /// The boolean extensions.
 /// </summary>
 
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class BooleanExtensions
 {
     /// <summary>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/DateTimeExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/DateTimeExtensions.cs
@@ -2,7 +2,9 @@
 /// <summary>
 /// The date time extensions.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class DateTimeExtensions
 {
     /// <summary>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/DecimalExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/DecimalExtensions.cs
@@ -3,7 +3,9 @@
 /// <summary>
 /// The decimal extensions.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class DecimalExtensions
 {
     /// <summary>

diff --git a/...Academisation.ExtensionMethods/ExtensionMethods/Dfe.Academisation.ExtensionMethods.csproj b/...Academisation.ExtensionMethods/ExtensionMethods/Dfe.Academisation.ExtensionMethods.csproj
@@ -6,14 +6,14 @@
 		<Nullable>enable</Nullable>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<Title>Dfe Academisation Extension Methods</Title>
-		<Description>A set of extension methods for use throughout the DfE Academisation process.</Description>
 		<PackageProjectUrl>https://github.com/DFE-Digital/academisation-nuget-packages/tree/main/extensionMethods</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/DFE-Digital/academisation-nuget-packages</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
 		<PackageTags>dfe;academisation;extension methods;</PackageTags>
-		<Version>2.0.0</Version>
+		<Version>2.0.1</Version>
 		<Authors>DFE-Digital</Authors>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
+		<Description>This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.</Description>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs
@@ -4,7 +4,9 @@
 /// <summary>
 /// The enum extensions.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class EnumExtensions
 {
     /// <summary>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/IntegerExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/IntegerExtensions.cs
@@ -2,7 +2,9 @@
 /// <summary>
 /// The integer extensions.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class IntegerExtensions
 {
     /// <summary>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/ObjectExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/ObjectExtensions.cs
@@ -2,7 +2,9 @@
 /// <summary>
 /// The object extensions.
 /// </summary>
-
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class ObjectExtensions
 {
     /// <summary>

diff --git a/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/StringExtensions.cs b/extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/StringExtensions.cs
@@ -5,6 +5,9 @@
 /// <summary>
 /// The string extensions.
 /// </summary>
+#pragma warning disable S1133
+[Obsolete("This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.")]
+#pragma warning restore S1133
 public static class StringExtensions
 {
     /// <summary>

diff --git a/...ionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/release_notes.md b/...ionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/release_notes.md
@@ -1,3 +1,7 @@
+# 2.0.1
+
+This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.
+
 # 2.0.0
 Added an optional `ignoreAcronyms` argument to StringExtensions.ToSentenceCase. This defaults to true to that existing use is not impacted, but allows for the situations where you know that there are no acronyms in a string and allows them to have sentence casing applied if they are all uppercase.
 

diff --git a/extensionMethods/README.md b/extensionMethods/README.md
@@ -1,3 +1,7 @@
+# Deprecated
+
+This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Utilities instead.
+
 # Extension Methods
 
 ## What does this do ?
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@

		This package is deprecated. Please use https://github.com/DFE-Digital/rsd-core-libs/pkgs/nuget/DfE.CoreLibs.Contracts instead.