Merge pull request #1064 from SteamRE/yaakov/rel-2.4.0

Update release notes and URL for v2.4.0 final

SteamKit2/SteamKit2/SteamKit2.csproj

@@ -5,7 +5,7 @@
     <AssemblyOriginatorKeyFile>..\..\SteamKit.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <Description>.NET library that aims to interoperate with the Steam network.</Description>
-    <PackageReleaseNotes>Release notes are available at https://github.com/SteamRE/SteamKit/releases/tag/2.4.0-Beta.1</PackageReleaseNotes>
+    <PackageReleaseNotes>Release notes are available at https://github.com/SteamRE/SteamKit/releases/tag/2.4.0</PackageReleaseNotes>
     <PackageIcon>steamkit_logo_128.png</PackageIcon>
     <PackageProjectUrl>https://github.com/SteamRE/SteamKit</PackageProjectUrl>
     <PackageLicenseExpression>LGPL-2.1-only</PackageLicenseExpression>

SteamKit2/SteamKit2/changes.txt

@@ -1,6 +1,8 @@
 ------------------------------------------------------------------------------
-v 2.4.0			November 17 2021 (Beta 1)
+v 2.4.0			December 4 2021
 ------------------------------------------------------------------------------
+* Updated protobuf-net dependency to v3.0.
+* Added a MemoryServerListProvider implementation.
 * Added `CallProtobufAsync<T>` method to WebAPI to deserialize response as Protobuf instead of KeyValues.
 * Added `SteamChinaOnly` flag to CDN server objects.
 * Added new APIs to allow consumers to provide their own machine info.
@@ -10,18 +12,36 @@ v 2.4.0			November 17 2021 (Beta 1)
 * Added new `SteamContent` handler.
 * Added the ability to set `ClientMsgProtoBuf<T>.Body`.
 * SteamKit2 now ships a net6.0 assembly as well as a netstandard2.0 assembly.
+* Enabled strong name signing on the SteamKit2 assembly.
 * Changed thread names to not get truncated on Linux.
 * Changed message handler exception handling to log the full `Exception` object rather than just the message.
 * Changed the implementation of `SteamUnifiedMessages` to use the newer message protocol under the hood.
+* Removed some DebugLog spam from WebSocket connections.
+* Updated C# nullability annotations.
+* Updated Steam enums and protobufs.
+
+Bug Fixes
+* Fixed a race in `CMClient.Send`.
+* Fixed a race in `AsyncJob` registration.
+* Fixed an issue opening files in `IsolatedStorageServerListProvider`.
+* Fixed throwing an exception when calling WebAPI twice with the same arguments.
+* Fixed WebAPI mutating the supplied arguments dictionary.
+* Fixed cryptographic errors in .NET 6 previews.
 * Fixed `IDebugNetworkListener` not being given encryption handshake messages.
 * Fixed a possible unhandled exception when opening a TCP connection.
 * Fixed the `UnobservedTaskException` event being triggered on .NET 6 if a TCP connection times out.
 * Fixed WebSocket connections constructing an incorrect IPv6 URI.
 * Fixed `DisconnectedCallback.UserInitiated` being true when a connection was terminated due to an internal error.
-* Removed some DebugLog spam from WebSocket connections.
-* Updated Protobufs.
+* Fixed `SmartCMServerList` getting fixated on the first CM server when all servers are marked as bad.
 
 BREAKING CHANGES
+* `SteamWorkshop.EnumerateUserPublishedFiles` and its associated callback has been removed.
+* `SteamWorkshop.EnumerateUserSubscribedFiles` and its associated callback has been removed.
+* `SteamApps.PICSRequest` has been changed from a class to a struct, and `only_public` has been removed.
+* A non-final optional parameter has been removed from `SteamApps.PICSGetProductInfo`. For any caller that supplied
+* three unnamed arguments, this is a source-breaking change as the value for `onlyPublic` will now be passed to the
+* method parameter `metaDataOnly`. Please audit your code for any calls to `PICSGetProductInfo` as the compiler will
+* not warn you about this change.
 * Changed `SteamApps.GetPICSProductInfo` signature to now use `PICSRequest` objects.
 * Removed some old non-Protobuf messages.
 * Updated nullability to match latest BCL annotations and to fix .NET 6 SDK analysis warnings.
@@ -35,48 +55,6 @@ BREAKING CHANGES
 * `CDN.Server.AllowedAppIds` is now not-nullable. Check for empty instead.
 
 
-------------------------------------------------------------------------------
-v 2.4.0			July 29 2021 (Alpha 3)
-------------------------------------------------------------------------------
-* Fixed throwing an exception when calling WebAPI twice with the same arguments. 
-* Fixed WebAPI mutating the supplied arguments dictionary.
-* Fixed cryptographic errors in .NET 6 previews.
-* Updated C# nullability annotations.
-* Updated Steam enums and protobufs.
-
-BREAKING CHANGES
-* `SteamWorkshop.EnumerateUserPublishedFiles` and its associated callback has been removed.
-* `SteamWorkshop.EnumerateUserSubscribedFiles` and its associated callback has been removed.
-* `SteamApps.PICSRequest` has been changed from a class to a struct, and `only_public` has been removed.
-* A non-final optional parameter has been removed from `SteamApps.PICSGetProductInfo`. For any caller that supplied
-  three unnamed arguments, this is a source-breaking change as the value for `onlyPublic` will now be passed to the
-  method parameter `metaDataOnly`. Please audit your code for any calls to `PICSGetProductInfo` as the compiler will
-  not warn you about this change.
-
-
-------------------------------------------------------------------------------
-v 2.4.0			March 9, 2021 (Alpha 2)
-------------------------------------------------------------------------------
-* CDN: Updated interface to capture `preferred_server`, `use_as_proxy`, `proxy_request_path` and `allowed_app_ids`.
-* CDN: CDNClient methods now accept an optional `proxyServer` parameter.
-* CDN: Separated the request timeout into configurable request/response timeouts.
-* Added a MemoryServerListProvider implementation.
-* Enabled strong name signing on the SteamKit2 assembly.
-* Protocol/definition updates.
-
-Bug Fixes
-* Fixed a race in CMClient.Send.
-* Fixed a race in AsyncJob registration.
-* Fixed an issue opening files in IsolatedStorageServerListProvider.
-
-
-------------------------------------------------------------------------------
-v 2.4.0			July 13, 2020 (Alpha 1)
-------------------------------------------------------------------------------
-* Updated protobuf-net dependency to v3.0.
-* Updated Steam protobufs.
-
-
 ------------------------------------------------------------------------------
 v 2.3.0			July 05, 2020 
 ------------------------------------------------------------------------------
@@ -218,7 +196,7 @@ This is the final release to support .NET Framework 4.5.
 ------------------------------------------------------------------------------
 v 1.8.2			Mar 23, 2017
 ------------------------------------------------------------------------------
-* Added support for Binary KeyValues field type 10 (`Int64`) (#376)
+* Added support for Binary KeyValues field type 10 (`Int64`)
 * Obsoleted `SteamApps.GetAppInfo`, `SteamApps.GetPackageInfo`, and `SteamApps.GetAppChanges`. Use the PICS equivalents instead.
 * Updated game-related GC messages and protobufs.