Merge pull request #26 from s2quake/ci/improve

Improve CI to make sure minimal checks are done before merge

.github/scripts/pack.ps1

@@ -0,0 +1,35 @@
+#!/usr/local/bin/pwsh
+param (
+    [ValidateScript({ ($_ -eq "") -or !(Test-Path $_ -PathType Leaf) })]
+    [string]$OutputPath = "",
+    [ValidateScript({ $_ -ge 0 })]
+    [int]$PullRequestNumber = 0,
+    [ValidateScript({ ($_ -eq "") -or (Test-Path $_) })]
+    [string]$KeyPath = ""
+)
+
+$namespaces = @{
+    ns = "http://schemas.microsoft.com/developer/msbuild/2003"
+}
+$propsPath = "Directory.Build.props"
+$fileVersionPath = "/ns:Project/ns:PropertyGroup/ns:FileVersion"
+$result = Select-Xml -Path $propsPath -Namespace $namespaces -XPath $fileVersionPath
+if ($null -eq $result) {
+    Write-Host "File version not found"
+    exit 1
+}
+
+$fileVersion = $result.Node.InnerText
+$KeyPath = $KeyPath ? $(Resolve-Path -Path $KeyPath) : ""
+$OutputPath = $OutputPath ? [System.IO.Path]::GetFullPath($OutputPath) : ""
+$keyPathExits = Test-Path -Path $KeyPath
+
+$options = @(
+    $OutputPath ? "-o '$OutputPath'" : ""
+    "-p:FileVersion='$fileVersion'"
+    $PullRequestNumber ? "--version-suffix pr.$PullRequestNumber" : ""
+    $keyPathExits ? "-p:TreatWarningsAsErrors=true" : ""
+    $keyPathExits ? "-p:AssemblyOriginatorKeyFile='$KeyPath'" : ""
+) | Where-Object { $_ }
+
+Invoke-Expression -Command "dotnet pack $($options -join " ")"

.github/workflows/build-and-test.yml

@@ -1,40 +1,33 @@
 name: Build and Test
 
 on:
-  pull_request: 
+  pull_request:
 
 env:
   TEST_RESULTS_PATH: ${{ github.workspace }}/test-results.trx
 
-permissions:
-  contents: read
-  actions: read
-  checks: write
-
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4.1.7
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4.0.0
+      - uses: actions/checkout@v4.1.7
+      - uses: actions/setup-dotnet@v4.0.0
         with:
           dotnet-version: 8.0.100
-      - name: Dotnet Build
-        run: dotnet build --configuration Release
-      - name: Dotnet Test
-        run: |
-          dotnet test --configuration Release --no-restore --no-build --logger "trx;LogFileName=${{ env.TEST_RESULTS_PATH }}"
-      - name: Upload test results
-        uses: actions/upload-artifact@v4
-        if: success() || failure()
-        with:
-          name: test-results
-          path: ${{ env.TEST_RESULTS_PATH }}
-      - name: Upload test results
-        uses: dorny/test-reporter@v1.9.1
-        if: success() || failure()
+      - run: echo "${{ secrets.SNK_FILE }}" | base64 --decode > private.snk
+      - run: |
+          dotnet build \
+          --configuration Release \
+          -p:TreatWarningsAsErrors=true \
+          -p:TreatWarningsAsErrors=true \
+          -p:AssemblyOriginatorKeyFile=$(pwd)/private.snk
+      - run: |
+          dotnet test \
+          --configuration Release \
+          --no-restore \
+          --no-build \
+          --logger "trx;LogFileName=${{ env.TEST_RESULTS_PATH }}"
+      - uses: dorny/test-reporter@v1
         with:
           name: XUnit Tests
           path: ${{ env.TEST_RESULTS_PATH }}

.github/workflows/check-changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+
+on: 
+  pull_request:
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tarides/changelog-check-action@v2
+        with:
+          changelog: CHANGES.md

.github/workflows/pack.yml

@@ -0,0 +1,49 @@
+name: Pack
+
+on:
+  pull_request: 
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+
+jobs:
+  pack:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.7
+      - uses: actions/setup-dotnet@v4.0.0
+        with:
+          dotnet-version: 8.0.100
+      - run: echo "${{ secrets.SNK_FILE }}" | base64 --decode > private.snk
+      - if: ${{ github.event_name == 'pull_request' }}
+        run: | 
+          .github/scripts/pack.ps1 `
+            -OutputPath "pack" `
+            -PullRequestNumber ${{ github.event.pull_request.number }} `
+            -KeyPath "$pwd/private.snk"
+        shell: pwsh
+      - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        run: | 
+          $commitMessage = "$(git log -1 --pretty=%B)"
+          $pattern = "(?<=Merge pull request #)(\d+)"
+          if (!($commitMessage -match $pattern)) {
+            Write-Error "Commit message does not contain a pull request number."
+          }
+
+          Remove-Item -Force -Recurse pack -ErrorAction SilentlyContinue  
+
+          .github/scripts/pack.ps1 `
+            -OutputPath "pack" `
+            -PullRequestNumber $matches[1] `
+            -KeyPath "$pwd/private.snk"
+
+          Get-ChildItem -Path pack -Filter "*.nupkg" | ForEach-Object {
+            dotnet nuget push `
+              $_ `
+              --skip-duplicate `
+              --api-key ${{ secrets.NUGET_API_KEY }} `
+              --source https://api.nuget.org/v3/index.json
+          }
+        shell: pwsh

.github/workflows/typos.yml

@@ -0,0 +1,11 @@
+name: Check Typos
+
+on: 
+  pull_request:
+
+jobs:
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: crate-ci/typos@v1.22.9

CHANGES.md

@@ -6,6 +6,10 @@ Communication changes
 
 To be released.
 
+* Improve CI to make sure minimal checks are done before merge [[#26]]
+
+[26]: https://github.com/s2quake/communication/pull/26
+
 
 2.0.2
 -------------

Directory.Build.props

@@ -57,7 +57,8 @@ SOFTWARE. -->
 	  <Copyright>Copyright (c) 2024 Jeesu Choi</Copyright>
 	  <Description>grpc-based communication library for crema project</Description>
 	  <Authors>s2quake</Authors>
-	  <PackageVersion>$(FileVersion)</PackageVersion>
+	  <PackageVersion Condition="'$(VersionSuffix)'==''">$(FileVersion)</PackageVersion>
+	  <PackageVersion Condition="'$(VersionSuffix)'!=''">$(FileVersion)-$(VersionSuffix)</PackageVersion>
     <PackageProjectUrl>https://github.com/s2quake/communication</PackageProjectUrl>
     <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
     <PackageReadmeFile>README.md</PackageReadmeFile>

Directory.Build.targets

@@ -29,11 +29,6 @@ SOFTWARE. -->
     <DesiredPublishDirTemp Condition="'$(PublishDir)' != '$(DesiredPublishDir)'">$(PublishDir)</DesiredPublishDirTemp>
     <DesiredPublishDir>$(DesiredPublishDirTemp)</DesiredPublishDir>
   </PropertyGroup>
-  <Target Name="BeforeBuild">
-    <PropertyGroup>
-      <Version>$(FileVersion)-$(TargetFramework)</Version>
-    </PropertyGroup>
-  </Target>
   <Target Name="AfterBuild">
     <PropertyGroup Condition="'$(PublishName)' != ''">
       <PublishDir>$([System.IO.Path]::Combine($(DesiredPublishDir),$(PublishName)))</PublishDir>

src/JSSoft.Communication/Extensions/ISerializerExtensions.cs

@@ -23,34 +23,34 @@ public static string[] SerializeMany(this ISerializer @this, Type[] types, objec
         return items;
     }
 
-    public static object?[] DeserializeMany(this ISerializer @this, Type[] types, string[] datas)
+    public static object?[] DeserializeMany(this ISerializer @this, Type[] types, string[] data)
     {
-        var items = new object?[datas.Length];
-        for (var i = 0; i < datas.Length; i++)
+        var items = new object?[data.Length];
+        for (var i = 0; i < data.Length; i++)
         {
             var type = types[i];
-            var value = datas[i];
+            var value = data[i];
             items[i] = @this.Deserialize(type, value);
         }
 
         return items;
     }
 
     public static object?[] DeserializeMany(
-        this ISerializer @this, Type[] types, string[] datas, CancellationToken? cancellationToken)
+        this ISerializer @this, Type[] types, string[] data, CancellationToken? cancellationToken)
     {
-        var length = cancellationToken != null ? datas.Length + 1 : datas.Length;
+        var length = cancellationToken != null ? data.Length + 1 : data.Length;
         var items = new object?[length];
-        for (var i = 0; i < datas.Length; i++)
+        for (var i = 0; i < data.Length; i++)
         {
             var type = types[i];
-            var value = datas[i];
+            var value = data[i];
             items[i] = @this.Deserialize(type, value);
         }
 
         if (cancellationToken != null)
         {
-            items[datas.Length] = cancellationToken;
+            items[data.Length] = cancellationToken;
         }
 
         return items;

src/JSSoft.Communication/Grpc/AdaptorServer.cs

@@ -139,7 +139,7 @@ public async Task<InvokeReply> InvokeAsync(InvokeRequest request, ServerCallCont
         var instance = peer.Services[service];
         var args = _serializer.DeserializeMany(
             types: methodDescriptor.ParameterTypes,
-            datas: [.. request.Data],
+            data: [.. request.Data],
             cancellationToken: cancellationToken);
         if (methodDescriptor.IsOneWay == true)
         {

src/JSSoft.Communication/Grpc/Peer.cs

@@ -47,7 +47,7 @@ public void EndPolling()
         }
     }
 
-    public void Disconect(int closeCode)
+    public void Disconnect(int closeCode)
     {
         lock (_lockObject)
         {

src/JSSoft.Communication/Grpc/PeerCollection.cs

@@ -38,7 +38,7 @@ public bool Remove(IServiceContext serviceContext, string id, int closeCode)
         {
             peer.Descriptor = null;
             _instanceContext.DestroyInstance(peer);
-            peer.Disconect(closeCode);
+            peer.Disconnect(closeCode);
             serviceContext.Debug($"{id} Disconnected ({closeCode})");
             return true;
         }
@@ -53,7 +53,7 @@ public async Task DisconnectAsync(
         using var cancellationTokenSource = new CancellationTokenSource(millisecondsDelay: 3000);
         foreach (var item in items)
         {
-            item.Disconect(closeCode: 0);
+            item.Disconnect(closeCode: 0);
         }
 
         while (Count > 0 && cancellationTokenSource.IsCancellationRequested != true)

src/JSSoft.Communication/MethodDescriptorCollection.cs

@@ -12,7 +12,7 @@ namespace JSSoft.Communication;
 
 public sealed class MethodDescriptorCollection : IEnumerable<MethodDescriptor>
 {
-    private readonly Dictionary<string, MethodDescriptor> _discriptorByName;
+    private readonly Dictionary<string, MethodDescriptor> _descriptorByName;
 
     internal MethodDescriptorCollection(Type type)
     {
@@ -25,23 +25,23 @@ internal MethodDescriptorCollection(Type type)
         {
             var methodInfos = type.GetMethods();
             var methodDescriptors = methodInfos.Select(item => new MethodDescriptor(item));
-            _discriptorByName = methodDescriptors.ToDictionary(item => item.Name);
+            _descriptorByName = methodDescriptors.ToDictionary(item => item.Name);
         }
         else
         {
-            _discriptorByName = [];
+            _descriptorByName = [];
         }
     }
 
-    public int Count => _discriptorByName.Count;
+    public int Count => _descriptorByName.Count;
 
-    public MethodDescriptor this[string name] => _discriptorByName[name];
+    public MethodDescriptor this[string name] => _descriptorByName[name];
 
-    public bool Contains(string name) => _discriptorByName.ContainsKey(name);
+    public bool Contains(string name) => _descriptorByName.ContainsKey(name);
 
     public IEnumerator<MethodDescriptor> GetEnumerator()
-        => _discriptorByName.Values.GetEnumerator();
+        => _descriptorByName.Values.GetEnumerator();
 
     IEnumerator IEnumerable.GetEnumerator()
-        => _discriptorByName.Values.GetEnumerator();
+        => _descriptorByName.Values.GetEnumerator();
 }

test/JSSoft.Communication.Tests/ClientTestBase.cs

@@ -57,9 +57,9 @@ public async Task DisposeAsync()
     }
 }
 
-public abstract class ClientTestBase<TService, TServerSevice> : IAsyncLifetime
+public abstract class ClientTestBase<TService, TServerService> : IAsyncLifetime
     where TService : class
-    where TServerSevice : ServerService<TService>
+    where TServerService : ServerService<TService>
 {
     private readonly ClientService<TService> _clientService = new();
     private readonly ServerContext _serverContext;
@@ -70,7 +70,7 @@ public abstract class ClientTestBase<TService, TServerSevice> : IAsyncLifetime
     private Guid _clientToken;
     private Guid _serverToken;
 
-    protected ClientTestBase(ITestOutputHelper logger, TServerSevice serverService)
+    protected ClientTestBase(ITestOutputHelper logger, TServerService serverService)
     {
         Logger = logger;
         ServerService = serverService;
@@ -82,7 +82,7 @@ protected ClientTestBase(ITestOutputHelper logger, TServerSevice serverService)
 
     protected TService Client => _client!;
 
-    protected TServerSevice ServerService { get; }
+    protected TServerService ServerService { get; }
 
     public async Task InitializeAsync()
     {