workflow for speechmatics-dotnet

Author: JamesG-Speechmatics

.github/workflows/dotnet.yml

@@ -5,27 +5,187 @@ name: .NET
 
 on:
   push:
-    branches: [ "master" ]
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+-*'
   pull_request:
-    branches: [ "master" ]
 
 jobs:
-  build:
+  format-check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+      working-directory: ./SmRtAPI
+    - name: lint
+      run: dotnet format --verify-no-changes
+      working-directory: ./SmRtAPI
 
+  build:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v3
     - name: Setup .NET
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       run: dotnet restore
       working-directory: ./SmRtAPI
+    - name: Lint
+      run: dotnet format --verify-no-changes
+      working-directory: ./SmRtAPI
     - name: Build
       run: dotnet build --no-restore SmRtAPI
       working-directory: ./SmRtAPI
     - name: Test
       run: dotnet test --no-build --verbosity normal SmRtAPI
       working-directory: ./SmRtAPI
+
+  package:
+    runs-on: ubuntu-latest
+    outputs:
+      nuget_repo: ${{ steps.version.outputs.nuget_repo }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.0.x
+      - name: Extract version from tag, choose nuget repo
+        id: version
+        run: |
+            set -euxo pipefail
+            NUGET_REPO="https://api.nuget.org/v3/index.json"
+            TAG_NAME="${GITHUB_REF##*/}"  # e.g., v2.0.0
+
+            if [[ "$TAG_NAME" != "merge" ]] && [[ ! "$TAG_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
+              echo "Invalid SemVer tag: $TAG_NAME"
+              exit 1
+            fi
+
+            VERSION="${TAG_NAME#v}"       # strip the leading "v"
+
+            if [[ "$VERSION" = "merge" ]]; then
+              # If it's not a tag, use a fixed version for the package, which will not be published
+              # text 'merge' comes from parsing "refs/pull/PULL_REQUEST_NUMBER/merge"
+              PR_NUMBER=$(echo "$GITHUB_REF" | sed -n 's#refs/pull/\([0-9]\+\)/merge#\1#p')
+              VERSION="2.0.${PR_NUMBER}"
+            fi
+
+            PACKAGE_VERSION=$VERSION
+
+            if [[ "$VERSION" == *-rc* ]]; then
+              # If it's a release candidate, use the test NuGet repo
+              SUFFIX="${VERSION#*-}"
+              VERSION="${VERSION%%-*}"
+              NUGET_REPO="https://apiint.nugettest.org/v3/index.json"
+            fi
+
+            echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+            echo "nuget_repo=$NUGET_REPO" >> "$GITHUB_OUTPUT"
+            echo "package_version=$PACKAGE_VERSION" >> "$GITHUB_OUTPUT"
+      - name: Restore dependencies
+        run: dotnet restore
+        working-directory: ./SmRtAPI/SmRtAPI
+      - name: Pack NuGet Package
+        run: |
+          set -euxo pipefail
+          mkdir -p ../docs
+          cp ../../README.md ../docs/README.md
+          COMMIT_SHA=$(git rev-parse HEAD)
+
+          dotnet pack \
+            -p:PackageLicenseExpression=MIT \
+            -p:PackageVersion=${{ steps.version.outputs.package_version }} \
+            -p:Version=${{ steps.version.outputs.version }} \
+            -p:AssemblyVersion=${{ steps.version.outputs.version }}.0  \
+            -p:RepositoryCommit=$COMMIT_SHA \
+            -p:Configuration=Release \
+            -p:PackageProjectUrl="https://github.com/speechmatics/speechmatics-dotnet" \
+            -o ../../nupkgs
+        working-directory: ./SmRtAPI/SmRtAPI
+      - name: Upload NuGet Packages to gibhub
+        uses: actions/upload-artifact@v4
+        with:
+          name: nupkgs
+          path: nupkgs/*.nupkg
+          retention-days: 1
+
+  sign:
+    runs-on: windows-latest
+    needs: package
+    env:
+      APP_ID: ${{ secrets.APP_ID }}
+      TENANT_ID: ${{ secrets.TENANT_ID }}
+      AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: nupkgs
+          path: nupkgs
+      - name: Sign
+        shell: pwsh
+        run: |
+          $timeserver = "http://timestamp.digicert.com"
+          $certificate_name = "GlobalSign-Code-Signing-Certificate"
+
+          dotnet tool install --tool-path . NuGetKeyVaultSignTool
+    
+          $nupkgFiles = Get-ChildItem -Path nupkgs -Filter *.nupkg
+          if ($nupkgFiles.Count -eq 0) {
+              Write-Host "No .nupkg files found in the directory."
+              exit 1
+          }
+          foreach ($file in $nupkgFiles) {
+            Write-Output "Signing $file"
+            ./NuGetKeyVaultSignTool sign $file `
+              --azure-key-vault-tenant-id "${{ env.TENANT_ID }}" `
+              --azure-key-vault-url "https://signing-key.vault.azure.net/" `
+              --azure-key-vault-client-id "${{ env.APP_ID }}" `
+              --azure-key-vault-client-secret "${{ env.AZURE_CLIENT_SECRET }}" `
+              --azure-key-vault-certificate "$certificate_name" `
+              --timestamp-rfc3161 $timeserver
+          }
+      - name: Upload signed NuGet packages to github
+        uses: actions/upload-artifact@v4
+        with:
+          name: signed_nupkgs
+          path: nupkgs/*.nupkg
+          retention-days: 1
+
+  publish:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: ["sign", "package"]
+    env:
+      NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
+      NUGET_API_KEY_TESTING: ${{ secrets.NUGET_API_KEY_TESTING }}
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: signed_nupkgs
+          path: nupkgs
+      - name: Publish nuget packages
+        shell: bash
+        run: |
+          set -euxo pipefail
+          NUGET_REPO="${{ needs.package.outputs.nuget_repo }}"
+
+          if [[ "$NUGET_REPO" == *nugettest* ]]; then
+            echo "Publishing to test NuGet repo"
+            NUGET_API_KEY="$NUGET_API_KEY_TESTING"
+          fi
+
+          for file in nupkgs/*.nupkg; do
+            echo "Publishing $file"
+            dotnet nuget verify $file
+            dotnet nuget push $file --api-key "$NUGET_API_KEY" --source "$NUGET_REPO"
+          done

SmRtAPI/DemoApp/Program.cs

@@ -58,20 +58,21 @@ public static void Main(string[] args)
                         AddPartialTranslationMessageCallback = s => Console.WriteLine(ToJson(s)),
                         ErrorMessageCallback = s => Console.WriteLine(ToJson(s)),
                         WarningMessageCallback = s => Console.WriteLine(ToJson(s)),
-                        CustomDictionaryPlainWords = new[] {"speechmagic"},
+                        CustomDictionaryPlainWords = new[] { "speechmagic" },
                         CustomDictionarySoundsLikes = new Dictionary<string, IEnumerable<string>>(),
                         Insecure = true,
                         EnablePartials = true,
                         EnableEntities = true,
-                        Diarization=DiarizationType.Speaker,
-                        TranslationConfig = new TranslationConfig() {
-                            TargetLanguages = new [] {"de"},
+                        Diarization = DiarizationType.Speaker,
+                        TranslationConfig = new TranslationConfig()
+                        {
+                            TargetLanguages = new[] { "de" },
                             EnablePartials = true
                         }
                     };
 
                     // We can do this here, or earlier. It's not used until .Run() is called on the API object.
-                    config.CustomDictionarySoundsLikes["gnocchi"] = new[] {"nokey", "noki"};
+                    config.CustomDictionarySoundsLikes["gnocchi"] = new[] { "nokey", "noki" };
 
                     var api = new SmRtApi(RtUrl,
                         stream,
@@ -89,7 +90,7 @@ public static void Main(string[] args)
             }
 
             var finish = DateTime.Now;
-            Debug.WriteLine("Starting at {0} -- {1}", finish, finish-start);
+            Debug.WriteLine("Starting at {0} -- {1}", finish, finish - start);
             Console.ReadLine();
         }
     }

SmRtAPI/DemoAppNetCore/DemoAppNetCore.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

SmRtAPI/SmRtAPI/Config/SmRtApiConfig.cs

@@ -12,22 +12,22 @@ public class SmRtApiConfig : SmRtApiConfigBase
         /// <summary>
         /// Action to perform on extended partial transcript data
         /// </summary>
-        public Action<AddPartialTranscriptMessage> AddPartialTranscriptMessageCallback { get; set; }
+        public Action<AddPartialTranscriptMessage>? AddPartialTranscriptMessageCallback { get; set; }
 
         /// <summary>
         /// Action to perform on extended transcript data
         /// </summary>
-        public Action<AddTranscriptMessage> AddTranscriptMessageCallback { get; set; }
+        public Action<AddTranscriptMessage>? AddTranscriptMessageCallback { get; set; }
 
         /// <summary>
         /// Action to perform on partial translation data
         /// </summary>
-        public Action<AddPartialTranslationMessage> AddPartialTranslationMessageCallback { get; set; }
+        public Action<AddPartialTranslationMessage>? AddPartialTranslationMessageCallback { get; set; }
 
         /// <summary>
         /// Action to perform on translation data
         /// </summary>
-        public Action<AddTranslationMessage> AddTranslationMessageCallback { get; set; }
+        public Action<AddTranslationMessage>? AddTranslationMessageCallback { get; set; }
 
         /// <summary>
         /// Create new config for a given language,

SmRtAPI/SmRtAPI/Config/TranslationConfig.cs

@@ -1,19 +1,18 @@
-using System;
 using System.Collections.Generic;
-using System.Text;
 
 namespace Speechmatics.Realtime.Client.Config
 {
 
     /// <summary>
     /// Additional configuration for translation
     /// </summary>
-    public class TranslationConfig {
+    public class TranslationConfig
+    {
 
         /// <summary>
         /// List of target languages to translate to
         /// </summary>
-        public IEnumerable<string> TargetLanguages { get; set; }
+        public IEnumerable<string> TargetLanguages { get; set; } = new List<string>();
 
         /// <summary>
         /// Flag for enabling translation partials.

SmRtAPI/SmRtAPI/Enumerations/AudioFormatEncoding.cs

@@ -7,9 +7,9 @@
 
     */
 
-/// <summary>
-/// Type of audio
-/// </summary>
+    /// <summary>
+    /// Type of audio
+    /// </summary>
     public enum AudioFormatEncoding
     {
         /// <summary>