[chore] Drop .NET 5.0 support, add .NET 9.0 support (#584)

- Drop .NET 5.0 support - Remove .NET 5.0 from CI - Add .NET 9.0 support - Use .NET 9.0 in CI - Add .NET 9.0 to nuspec - Update nuspec tags, docs link - Clean up bad docstrings
EasyPost · Nov 22, 2024 · a78d48e · a78d48e
1 parent 127dbb5
commit a78d48e
Show file tree

Hide file tree

Showing 16 changed files with 52 additions and 129 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Set up dotnet tools
         run: make install install-styleguide
@@ -31,7 +31,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Set up dotnet tools
         run: make install install-styleguide
@@ -51,7 +51,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Set up dotnet tools and dependencies
         run: make install
@@ -67,7 +67,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Set up dotnet tools and dependencies
         run: make install
@@ -102,7 +102,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Install docfx
         run: make install-tools
@@ -124,21 +124,21 @@ jobs:
       EASYPOST_PROD_API_KEY: "123"
     strategy:
       matrix:
-        name: [ 'NetStandard20', 'Net50', 'Net60', 'Net70', 'Net80' ]
+        name: [ 'NetStandard20', 'Net60', 'Net70', 'Net80', 'Net90' ]
         include:
           - name: NetStandard20
             # can't run tests on .NET Standard, it's just a bridge between .NET Framework and .NET.
             # So we'll target .NET Framework 4.6.2
             # More notes at the bottom of this file
             framework: net462
-          - name: Net50
-            framework: net5.0
           - name: Net60
             framework: net6.0
           - name: Net70
             framework: net7.0
           - name: Net80
             framework: net8.0
+          - name: Net90
+            framework: net9.0
     steps:
       - uses: actions/checkout@v4
         with:
@@ -147,10 +147,11 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          # .NET 5.0 is deprecated and removed from GitHub Actions, we need to manually install it
           dotnet-version: |
-            5.x.x
+            6.x.x
+            7.x.x
             8.x.x
+            9.x.x
 
       - name: Setup MSBuild
         uses: microsoft/[email protected]
@@ -187,7 +188,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Setup MSBuild
         uses: microsoft/[email protected]
@@ -207,7 +208,7 @@ jobs:
 
         # Run the integration tests
       - name: Run Tests
-        run: make integration-test fw=net7.0  # Always run integration tests on the latest framework
+        run: make integration-test fw=net9.0  # Always run integration tests on the latest framework
 
   FSharp_Compatibility_Tests:
     runs-on: windows-2022
@@ -219,7 +220,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Setup MSBuild
         uses: microsoft/[email protected]
@@ -239,7 +240,7 @@ jobs:
 
         # Run the compatibility tests
       - name: Run Tests
-        run: make fs-compat-test fw=net7.0  # Always run compatibility tests on the latest framework
+        run: make fs-compat-test fw=net9.0  # Always run compatibility tests on the latest framework
 
   Visual_Basic_Compatibility_Test:
     runs-on: windows-2022
@@ -252,7 +253,7 @@ jobs:
       - name: Install .NET SDK
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x.x
+          dotnet-version: 9.x.x
 
       - name: Setup MSBuild
         uses: microsoft/[email protected]
@@ -272,7 +273,7 @@ jobs:
 
         # Run the compatibility tests
       - name: Run Tests
-        run: make vb-compat-test fw=net7.0  # Always run compatibility tests on the latest framework
+        run: make vb-compat-test fw=net9.0  # Always run compatibility tests on the latest framework
 
 
 # .NET Standard notes:

diff --git a/EasyPost.Compatibility.FSharp/EasyPost.Compatibility.FSharp.fsproj b/EasyPost.Compatibility.FSharp/EasyPost.Compatibility.FSharp.fsproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
         <RootNamespace>EasyPost.Compatibility.FSharp</RootNamespace>

diff --git a/EasyPost.Compatibility.FSharp/packages.lock.json b/EasyPost.Compatibility.FSharp/packages.lock.json
@@ -1,7 +1,7 @@
 {
   "version": 1,
   "dependencies": {
-    "net8.0": {
+    "net9.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",

diff --git a/EasyPost.Compatibility.VB/EasyPost.Compatibility.VB.vbproj b/EasyPost.Compatibility.VB/EasyPost.Compatibility.VB.vbproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <RootNamespace>EasyPost.Compatibility.VB</RootNamespace>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
   </PropertyGroup>
 

diff --git a/EasyPost.Compatibility.VB/packages.lock.json b/EasyPost.Compatibility.VB/packages.lock.json
@@ -1,7 +1,7 @@
 {
   "version": 1,
   "dependencies": {
-    "net8.0": {
+    "net9.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",

diff --git a/EasyPost.Integration/EasyPost.Integration.csproj b/EasyPost.Integration/EasyPost.Integration.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net462;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
+        <TargetFrameworks>net462;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
         <LangVersion>latest</LangVersion>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>

diff --git a/EasyPost.Tests/EasyPost.Tests.csproj b/EasyPost.Tests/EasyPost.Tests.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net462;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net462;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
 
     <IsPackable>false</IsPackable>
 

diff --git a/EasyPost.Tests/ExceptionsTests/ExceptionsTest.cs b/EasyPost.Tests/ExceptionsTests/ExceptionsTest.cs
@@ -15,6 +15,7 @@
 
 namespace EasyPost.Tests.ExceptionsTests
 {
+#pragma warning disable CA2263
     public class ExceptionsTests : UnitTest
     {
         public ExceptionsTests() : base("exceptions")
@@ -31,6 +32,7 @@ public async Task TestApiExceptionPrettyPrint()
 
             // Generate a dummy HttpResponseMessage with the given status code to parse
             HttpStatusCode httpStatusCode = (HttpStatusCode)Enum.Parse(typeof(HttpStatusCode), statusCode.ToString(CultureInfo.InvariantCulture));
+
             HttpResponseMessage response = new() { StatusCode = httpStatusCode };
 
             ApiError generatedError = await ApiError.FromErrorResponse(response);
@@ -480,4 +482,5 @@ public async Task TestHTTPTimeoutFriendlyException()
 
         #endregion
     }
+#pragma warning restore CA2263
 }
diff --git a/EasyPost.Tests/packages.lock.json b/EasyPost.Tests/packages.lock.json
@@ -264,7 +264,7 @@
         }
       }
     },
-    ".NETCoreApp,Version=v5.0": {
+    "net6.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",
@@ -375,11 +375,7 @@
       "Microsoft.Extensions.Logging.Abstractions": {
         "type": "Transitive",
         "resolved": "6.0.0",
-        "contentHash": "/HggWBbTwy8TgebGSX5DBZ24ndhzi93sHUBDvP1IxbZD7FDokYzdAr6+vbWGjw2XAfR2EJ1sfKUotpjHnFWPxA==",
-        "dependencies": {
-          "System.Buffers": "4.5.1",
-          "System.Memory": "4.5.4"
-        }
+        "contentHash": "/HggWBbTwy8TgebGSX5DBZ24ndhzi93sHUBDvP1IxbZD7FDokYzdAr6+vbWGjw2XAfR2EJ1sfKUotpjHnFWPxA=="
       },
       "Microsoft.Extensions.Options": {
         "type": "Transitive",
@@ -426,11 +422,6 @@
         "resolved": "5.11.0",
         "contentHash": "eaiXkUjC4NPcquGWzAGMXjuxvLwc6XGKMptSyOGQeT0X70BUZObuybJFZLA0OfTdueLd3US23NBPTBb6iF3V1Q=="
       },
-      "System.Buffers": {
-        "type": "Transitive",
-        "resolved": "4.5.1",
-        "contentHash": "Rw7ijyl1qqRS0YQD/WycNst8hUUMgrMH4FCn1nNm27M4VxchZ1js3fVjQaANHO5f3sN4isvP4a+Met9Y4YomAg=="
-      },
       "System.Diagnostics.DiagnosticSource": {
         "type": "Transitive",
         "resolved": "6.0.0",
@@ -439,11 +430,6 @@
           "System.Runtime.CompilerServices.Unsafe": "6.0.0"
         }
       },
-      "System.Memory": {
-        "type": "Transitive",
-        "resolved": "4.5.4",
-        "contentHash": "1MbJTHS1lZ4bS4FmsJjnuGJOu88ZzTT2rLvrhW7Ygic+pC0NWA+3hgAen0HRdsocuQXCkUTdFn9yHJJhsijDXw=="
-      },
       "System.Reflection.Metadata": {
         "type": "Transitive",
         "resolved": "1.6.0",
@@ -506,7 +492,7 @@
         }
       }
     },
-    "net6.0": {
+    "net7.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",
@@ -734,7 +720,7 @@
         }
       }
     },
-    "net7.0": {
+    "net8.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",
@@ -962,7 +948,7 @@
         }
       }
     },
-    "net8.0": {
+    "net9.0": {
       "coverlet.collector": {
         "type": "Direct",
         "requested": "[3.1.2, 4.0.0)",

diff --git a/EasyPost.nuspec b/EasyPost.nuspec
@@ -9,18 +9,15 @@
         <projectUrl>https://www.easypost.com</projectUrl>
         <license type="expression">MIT</license>
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
-        <description>EasyPost Shipping API Client Library for .NET https://easypost.com/docs</description>
-        <tags>EasyPost ShippingAPI USPS UPS FedEx</tags>
+        <description>EasyPost Shipping API Client Library for .NET https://docs.easypost.com</description>
+        <tags>EasyPost shipping API USPS UPS FedEx DHL CanadaPost RoyalMail mail package logistics rate insurance</tags>
         <readme>docs\README.md</readme>
         <releaseNotes>See Release Notes at https://github.com/EasyPost/easypost-csharp/releases</releaseNotes>
         <icon>images\icon.png</icon>
         <dependencies>
             <group targetFramework="netstandard2.0">
                 <dependency id="Newtonsoft.Json" version="[13.0.1, 14.0.0)" />
             </group>
-            <group targetFramework="net5.0">
-                <dependency id="Newtonsoft.Json" version="[13.0.1, 14.0.0)" />
-            </group>
             <group targetFramework="net6.0">
                 <dependency id="Newtonsoft.Json" version="[13.0.1, 14.0.0)" />
             </group>
@@ -30,19 +27,22 @@
             <group targetFramework="net8.0">
                 <dependency id="Newtonsoft.Json" version="[13.0.1, 14.0.0)" />
             </group>
+            <group targetFramework="net9.0">
+                <dependency id="Newtonsoft.Json" version="[13.0.1, 14.0.0)" />
+            </group>
         </dependencies>
     </metadata>
     <files>
         <file src="lib\net\netstandard2.0\EasyPost.dll" target="lib\netstandard2.0" />
         <file src="lib\net\netstandard2.0\EasyPost.XML" target="lib\netstandard2.0" />
-        <file src="lib\net\net5.0\EasyPost.dll" target="lib\net5.0" />
-        <file src="lib\net\net5.0\EasyPost.XML" target="lib\net5.0" />
         <file src="lib\net\net6.0\EasyPost.dll" target="lib\net6.0" />
         <file src="lib\net\net6.0\EasyPost.XML" target="lib\net6.0" />
         <file src="lib\net\net7.0\EasyPost.dll" target="lib\net7.0" />
         <file src="lib\net\net7.0\EasyPost.XML" target="lib\net7.0" />
         <file src="lib\net\net8.0\EasyPost.dll" target="lib\net8.0" />
         <file src="lib\net\net8.0\EasyPost.XML" target="lib\net8.0" />
+        <file src="lib\net\net9.0\EasyPost.dll" target="lib\net9.0" />
+        <file src="lib\net\net9.0\EasyPost.XML" target="lib\net9.0" />
         <file src="README.md" target="docs\" />
         <file src="icon.png" target="images\" />
     </files>

diff --git a/EasyPost/EasyPost.csproj b/EasyPost/EasyPost.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <OutputType>Library</OutputType>

diff --git a/EasyPost/Parameters/Tracker/CreateList.cs b/EasyPost/Parameters/Tracker/CreateList.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
@@ -6,9 +7,10 @@
 namespace EasyPost.Parameters.Tracker
 {
     /// <summary>
-    ///     Parameters for <see cref="EasyPost.Services.TrackerService.CreateList(CreateList, System.Threading.CancellationToken)"/> API calls.
+    ///     This parameter set is no longer used.
     /// </summary>
     [ExcludeFromCodeCoverage]
+    [Obsolete("This parameter set is no longer used.")]
     public class CreateList : BaseParameters<Models.API.Tracker>, ITrackerParameter
     {
         #region Request Parameters
@@ -67,8 +69,9 @@ public override Dictionary<string, object> ToDictionary()
     }
 
     /// <summary>
-    ///     Internal class used to construct a <see cref="CreateList"/> parameter set.
+    ///     This class is no longer used.
     /// </summary>
+    [Obsolete("This class is no longer used.")]
     internal sealed class CreateListTracker
     {
         /// <summary>