Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Deprecated the NuGet Packages #20

Merged
merged 5 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion academiesContracts/Dfe.Academies.Contracts/README.md
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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
/// <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>
/// Acdemic Year
/// </summary>
public string Year { get; set; }

Check warning on line 14 in academiesContracts/Dfe.Academies.Contracts/V1/EducationalPerformance/SchoolAbsenceDataDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Year' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

/// <summary>
///Percentage of possible mornings or afternoons recorded as an absence from school for whatever reason,
Expand Down
3 changes: 3 additions & 0 deletions academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@
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
{
public string Street { get; set; }

Check warning on line 14 in academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Street' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string Town { get; set; }

Check warning on line 16 in academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Town' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string County { get; set; }

Check warning on line 18 in academiesContracts/Dfe.Academies.Contracts/V4/AddressDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'County' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string Postcode { get; set; }

Expand Down
Original file line number Diff line number Diff line change
@@ -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
{

Expand Down
Original file line number Diff line number Diff line change
@@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,21 @@

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
{
public string Name { get; set; }

Check warning on line 11 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Name' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string Ukprn { get; set; }

Check warning on line 13 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Ukprn' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
public NameAndCodeDto Type { get; set; }

Check warning on line 14 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Type' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string CompaniesHouseNumber { get; set; }

Check warning on line 16 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'CompaniesHouseNumber' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public string ReferenceNumber { get; set; }

Check warning on line 18 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'ReferenceNumber' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

public AddressDto Address { get; set; }

Check warning on line 20 in academiesContracts/Dfe.Academies.Contracts/V4/Trusts/TrustDto.cs

View workflow job for this annotation

GitHub Actions / build

Non-nullable property 'Address' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.

}
Original file line number Diff line number Diff line change
@@ -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 />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 3 additions & 1 deletion correlationIdMiddleware/correlationIdMiddleware/Keys.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
5 changes: 5 additions & 0 deletions correlationIdMiddleware/correlationIdMiddleware/README.md
Original file line number Diff line number Diff line change
@@ -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 ?
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -19,11 +21,11 @@
{
return string.Empty;
}
string description = source.ToString();

Check warning on line 24 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Converting null literal or possible null value to non-nullable type.

Check warning on line 24 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Converting null literal or possible null value to non-nullable type.

FieldInfo fi = source.GetType().GetField(description);

Check warning on line 26 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Possible null reference argument for parameter 'name' in 'FieldInfo? Type.GetField(string name)'.

Check warning on line 26 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Converting null literal or possible null value to non-nullable type.

Check warning on line 26 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Possible null reference argument for parameter 'name' in 'FieldInfo? Type.GetField(string name)'.

Check warning on line 26 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Converting null literal or possible null value to non-nullable type.

DescriptionAttribute[] attributes = (DescriptionAttribute[])fi?.GetCustomAttributes(typeof(DescriptionAttribute), false);

Check warning on line 28 in extensionMethods/Dfe.Academisation.ExtensionMethods/ExtensionMethods/EnumExtensions.cs

View workflow job for this annotation

GitHub Actions / build

Converting null literal or possible null value to non-nullable type.

return attributes is { Length: > 0 }
? attributes[0].Description
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 4 additions & 0 deletions extensionMethods/README.md
Original file line number Diff line number Diff line change
@@ -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 ?
Expand Down
Loading