Merge pull request #1201 from ably/release/1.2.10

Release/1.2.10

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [1.2.10](https://github.com/ably/ably-dotnet/tree/1.2.10) (2023-01-24)
+
+[Full Changelog](https://github.com/ably/ably-dotnet/compare/1.2.9...1.2.10)
+
+**Closed issues:**
+- Implement RSC7d \(Ably-Agent header\) [\#498](https://github.com/ably/ably-dotnet/issues/498)
+- AuthCallback returned a string which can't be converted to TokenRequest [\#1196](https://github.com/ably/ably-dotnet/issues/1196)
+- Unable to output Debug Logging to console [\#1182](https://github.com/ably/ably-dotnet/issues/1182)
+- Unity iOS: Errors while creating transport [\#764](https://github.com/ably/ably-dotnet/issues/764)
+- Unity: When building for iOS, an IL2CPP error prevents the app working [\#751](https://github.com/ably/ably-dotnet/issues/751)
+- Unity 2019.3.5 - System.EntryPointNotFoundException: CreateNLSocket [\#408](https://github.com/ably/ably-dotnet/issues/408)
+
+**Merged pull requests:**
+
+- Fix authCallback token string [\#1197](https://github.com/ably/ably-dotnet/pull/1197) ([sacOO7](https://github.com/sacOO7))
+- Feature/agent header [\#1195](https://github.com/ably/ably-dotnet/pull/1195) ([sacOO7](https://github.com/sacOO7))
+
 ## [1.2.9](https://github.com/ably/ably-dotnet/tree/1.2.9) (2022-08-31)
 
 [Full Changelog](https://github.com/ably/ably-dotnet/compare/1.2.8...1.2.9)

CONTRIBUTING.md

@@ -101,12 +101,19 @@ Note: it was recently decided to remove explicit mention of Windows 7 as a suppo
 
 This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
 
-1. Create a release branch named in the form `release/1.2.3`.
-2. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the `CHANGELOG` update has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.2.3`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
-3. Update the version number and commit that change.
-4. Create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`.
-5. Run `package.cmd` to create the nuget package.
-6. Run `nuget push ably.io.*.nupkg -Source https://www.nuget.org/api/v2/package` (a private nuget API Key is required to complete this step, more information on publishing nuget packages can be found [here](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package))
-7. Against `main`, add a tag for the version and push to origin such as `git tag 1.2.3 && git push origin 1.2.3`.
-8. Visit [https://github.com/ably/ably-dotnet/tags](https://github.com/ably/ably-dotnet/tags) and `Add release notes` for the release including links to the changelog entry.
-9. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/))
+1. Create a branch for the release, named like release/1.2.3 (where 1.2.3 is the new version number).
+2. Replace all references of the current version number with the new version number and commit the changes (In current case, files are `src/CommonAssemblyInfo.cs` and `unity/Assets/Ably/version.txt`).
+3. Run `./unity-plugins-updater.sh 1.2.3` (linux/mac) / `.\unity-plugins-updater.cmd 1.2.3` (windows) at root and commit generated `.dll` and `.pdb` files.
+4. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). This may require some manual intervention, both in terms of how the command is run and how the change log file is modified. Your mileage may vary:
+  - The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-dotnet --since-tag 1.2.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
+  - Using the command above, `--output delta.md` writes changes made after `--since-tag` to a new file.
+  - The contents of that new file (`delta.md`) then need to be manually inserted at the top of the `CHANGELOG.md`, changing the "Unreleased" heading and linking with the current version numbers.
+  - Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD`.
+5. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`.
+6. Push the branch and create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`.
+7. Run `.\package.cmd 1.2.3` (windows) / `./package.sh 1.2.3` (linux/mac) to create the nuget package.
+8. Run `dotnet nuget push ably.io.*.nupkg --api-key GENERATED_API_KEY_FROM_NUGET_ACCOUNT --source https://api.nuget.org/v3/index.json` (More information on publishing nuget packages can be found [here](https://learn.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package-using-visual-studio?tabs=netcore-cli#publish-with-the-net-cli-or-nuget-cli))
+9. Add a tag to the new `main` head commit and push to origin such as `git tag 1.2.3 && git push origin 1.2.3`
+10. Visit [https://github.com/ably/ably-dotnet/tags](https://github.com/ably/ably-dotnet/tags) and `Add release notes` for the release including links to the changelog entry.
+11. Export unity package (exclude tests) as per https://docs.unity3d.com/Manual/AssetPackagesCreate.html with `io.ably.1.2.3.unitypackage` as a file name, upload it to the latest release note.
+12. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)).

COPYRIGHT

@@ -1 +1 @@
-Copyright 2015-2022 Ably Real-time Ltd (ably.com)
+Copyright 2015-2023 ably Real-time Ltd (ably.com)

build.cmd

@@ -1,3 +1,4 @@
 @echo off
 cls
-if "%~1"=="" (fake run build.fsx) else (fake run build.fsx -t %*)
+dotnet tool restore
+if "%~1"=="" (dotnet fake run build.fsx) else (dotnet fake run build.fsx -t %*)

build.sh

@@ -1,5 +1,9 @@
-#!/bin/bash
-
+#! /bin/bash
 dotnet tool restore
 
-dotnet fake run build.fsx -t $1
+if [ $# -eq 0 ]
+then
+    dotnet fake run build.fsx
+else
+    dotnet fake run build.fsx -t $@
+fi

package-push.sh

@@ -1,5 +1,14 @@
 #! /bin/bash
-
-dotnet tool restore
-
-dotnet fake run build.fsx -t PushPackage -v $1
+echo "===================================================================================="
+echo "       Script for building ably.io.push.android.*.nupkg and ably.io.push.ios.*.nupkg"
+echo "===================================================================================="
+echo " "
+echo "Warning : you should run this script on mac since it also needs to build package for iOS"
+echo " "
+if [ $# -eq 0 ]
+then
+	echo "Provide latest version number like package-push.sh 1.2.8"
+else
+	dotnet tool restore
+	dotnet fake run build.fsx -t PushPackage -v $1
+fi

package.cmd

@@ -1,2 +1,5 @@
 @echo off
+echo ======================================================
+echo        Script for building ably.io.*.nupkg
+echo ======================================================
 if "%~1"=="" (echo "Provide version number like package.cmd 1.1.15") else (build.cmd Package -v %*)

package.sh

@@ -0,0 +1,11 @@
+#! /bin/bash
+echo "======================================================"
+echo "       Script for building ably.io.*.nupkg            "
+echo "======================================================"
+echo " "
+if [ $# -eq 0 ]
+then
+    echo "Provide latest version number like package.sh 1.2.8"
+else
+    ./build.sh Package -v $1
+fi

src/CommonAssemblyInfo.cs

@@ -4,13 +4,13 @@
 
 [assembly: AssemblyCompany("Ably")]
 [assembly: AssemblyProduct("Ably .NET Library")]
-[assembly: AssemblyVersion("1.2.9")]
-[assembly: AssemblyFileVersion("1.2.9")]
+[assembly: AssemblyVersion("1.2.10")]
+[assembly: AssemblyFileVersion("1.2.10")]
 namespace System {
     internal static class AssemblyVersionInformation {
         internal const System.String AssemblyCompany = "Ably";
         internal const System.String AssemblyProduct = "Ably .NET Library";
-        internal const System.String AssemblyVersion = "1.2.9";
-        internal const System.String AssemblyFileVersion = "1.2.9";
+        internal const System.String AssemblyVersion = "1.2.10";
+        internal const System.String AssemblyFileVersion = "1.2.10";
     }
 }

unity-plugins-updater.cmd

@@ -0,0 +1,9 @@
+@echo off
+if "%~1"=="" (echo "Provide latest version number like unity-plugins-updater.cmd 1.2.8") else (
+	dotnet fake run build.fsx -t Build.NetStandard
+	copy src\IO.Ably.NETStandard20\bin\Release\netstandard2.0\IO.Ably.dll unity\Assets\Ably\Plugins
+	copy src\IO.Ably.NETStandard20\bin\Release\netstandard2.0\IO.Ably.pdb unity\Assets\Ably\Plugins 
+	copy src\IO.Ably.NETStandard20\bin\Release\netstandard2.0\IO.Ably.DeltaCodec.dll unity\Assets\Ably\Plugins
+	copy src\IO.Ably.NETStandard20\bin\Release\netstandard2.0\IO.Ably.DeltaCodec.pdb unity\Assets\Ably\Plugins
+	echo %~1 > unity\Assets\Ably\version.txt
+)

unity-plugins-updater.sh

@@ -0,0 +1,11 @@
+if [ $# -eq 0 ]
+then
+  echo "Provide latest version number like unity-plugins-updater.sh 1.2.8"
+else
+	dotnet fake run build.fsx -t Build.NetStandard
+	cp src/IO.Ably.NETStandard20/bin/Release/netstandard2.0/IO.Ably.dll unity/Assets/Ably/Plugins
+	cp src/IO.Ably.NETStandard20/bin/Release/netstandard2.0/IO.Ably.pdb unity/Assets/Ably/Plugins 
+	cp src/IO.Ably.NETStandard20/bin/Release/netstandard2.0/IO.Ably.DeltaCodec.dll unity/Assets/Ably/Plugins
+	cp src/IO.Ably.NETStandard20/bin/Release/netstandard2.0/IO.Ably.DeltaCodec.pdb unity/Assets/Ably/Plugins
+	echo $1 > unity/Assets/Ably/version.txt
+fi

unity/Assets/Ably/version.txt

@@ -1 +1 @@
-1.2.9 
+1.2.10