Merge branch 'dev'

Author: mikecarr

.github/workflows/build-flatpak.yml

@@ -30,6 +30,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
@@ -70,6 +72,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Download build artifacts
         uses: actions/download-artifact@v4
@@ -254,11 +258,11 @@ jobs:
 
       - name: Create metainfo file
         run: |
-          # Get version from tag or use default
+          # Get version from tag or use git hash
           if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
             VERSION=${GITHUB_REF#refs/tags/v}
           else
-            VERSION="1.0.0"
+            VERSION="0.0.0-dev+$(git rev-parse --short HEAD)"
           fi
           
           cat > ${{ env.APP_ID }}.metainfo.xml << EOF
@@ -319,6 +323,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Download Flatpak artifacts
         uses: actions/download-artifact@v4
@@ -347,4 +353,4 @@ jobs:
           draft: false
           prerelease: false
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build_and_release_all.yml

@@ -52,29 +52,22 @@ jobs:
         with:
           # If manually triggered, use the input branch; otherwise use the tag ref
           ref: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.target_branch || github.ref_name }}
+          fetch-depth: 0
 
-      - name: Setup .NET (8.x)
-        uses: actions/setup-dotnet@v3
-        with:
-          dotnet-version: '8.0.x'
-
-      - name: Read Version
-        id: get_version
+      - name: Ensure full git history
         shell: bash
         run: |
           set -euo pipefail
-      
-          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
-            VERSION="0.0.1"
-          elif [[ "${{ github.ref_type }}" == "tag" ]]; then
-            VERSION="${GITHUB_REF#refs/tags/}"
-            VERSION="${VERSION#release-v}"
+          if git rev-parse --is-shallow-repository | grep -q true; then
+            git fetch --prune --unshallow --tags
           else
-            VERSION="0.0.0-dev"
+            git fetch --prune --tags
           fi
-      
-          echo "VERSION=$VERSION" >> "$GITHUB_ENV"
-          echo "v$VERSION" > Companion.Desktop/VERSION
+
+      - name: Setup .NET (8.x)
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.0.x'
 
       - name: Restore dependencies
         run: dotnet restore Companion.Desktop/Companion.Desktop.csproj
@@ -108,19 +101,6 @@ jobs:
               -p:PublishSingleFile=true
           fi
 
-      - name: Write VERSION into publish output
-        shell: bash
-        run: |
-          set -euo pipefail
-          case "${{ runner.os }}" in
-            Windows) PUBLISH_DIR="Companion.Desktop/bin/Release/net8.0/win-${{ matrix.arch }}/publish" ;;
-            macOS)   PUBLISH_DIR="Companion.Desktop/bin/Release/net8.0/osx-${{ matrix.arch }}/publish" ;;
-            Linux)   PUBLISH_DIR="Companion.Desktop/bin/Release/net8.0/linux-${{ matrix.arch }}/publish" ;;
-          esac
-          echo "v${{ env.VERSION }}" > "$PUBLISH_DIR/VERSION"
-          echo "Wrote VERSION to $PUBLISH_DIR/VERSION:"
-          cat "$PUBLISH_DIR/VERSION"
-      
       # ----- macOS: bundle .app + sign + dmg -----
       - name: Decode signing certificate
         if: matrix.os == 'macos-latest'
@@ -267,6 +247,9 @@ jobs:
           hdiutil create -volname "Companion" -srcfolder dmg_build -ov -format UDZO -fs HFS+ -size 500m "${DMG_NAME}"
           rm -rf dmg_build
 
+          rm -f "Companion-macos-${{ matrix.arch }}.zip"
+          zip -r "Companion-macos-${{ matrix.arch }}.zip" "${APP_DIR}"
+
       # ----- Linux packaging -----
       - name: Linux - zip publish folder
         if: matrix.os == 'ubuntu-latest'
@@ -301,6 +284,13 @@ jobs:
           name: Companion-macos-${{ matrix.arch }}
           path: Companion-macos-${{ matrix.arch }}.dmg
           compression-level: 9
+      - name: Upload macOS App Zip
+        if: matrix.os == 'macos-latest'
+        uses: actions/upload-artifact@v4
+        with:
+          name: Companion-macos-${{ matrix.arch }}-app
+          path: Companion-macos-${{ matrix.arch }}.zip
+          compression-level: 9
 
       - name: Upload Windows Artifact
         if: matrix.os == 'windows-latest'
@@ -314,7 +304,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: Companion-linux-${{ matrix.arch }}
-          path: Companion-linux-${{ matrix.arch }}.zip
+          path: ./Companion.Desktop/bin/Release/net8.0/linux-${{ matrix.arch }}/publish/**
           compression-level: 0
 
   release:
@@ -353,11 +343,17 @@ jobs:
             fi
           done
 
-          # Copy Linux zips (they are inside artifact folders)
-          find ./artifacts -type f -name "Companion-linux-*.zip" -exec cp {} ./release_files/ \;
+          # Re-zip Linux folders to a single file per arch
+          for arch in x64 arm64; do
+            if [ -d "./artifacts/Companion-linux-${arch}" ]; then
+              (cd "./artifacts/Companion-linux-${arch}" && zip -r "../../release_files/Companion-linux-${arch}.zip" .)
+            fi
+          done
 
           # Copy macOS DMGs (also inside artifact folders)
           find ./artifacts -type f -name "Companion-macos-*.dmg" -exec cp {} ./release_files/ \;
+          # Copy macOS app zips
+          find ./artifacts -type f -name "Companion-macos-*.zip" -exec cp {} ./release_files/ \;
 
           ls -la ./release_files
 
@@ -385,10 +381,11 @@ jobs:
             ### Downloads
             * **Windows**: `Companion-windows-x64.zip` / `Companion-windows-arm64.zip`
             * **macOS**: `Companion-macos-x64.dmg` / `Companion-macos-arm64.dmg`
+            * **macOS (App ZIP)**: `Companion-macos-x64.zip` / `Companion-macos-arm64.zip`
             * **Linux**: `Companion-linux-x64.zip` / `Companion-linux-arm64.zip`
 
             ### Install
             * **Windows**: unzip and run `Companion.Desktop.exe`.
-            * **macOS**: open `.dmg` and drag **Companion.app** to Applications.
+            * **macOS**: open `.dmg` and drag **Companion.app** to Applications. (ZIP contains the `.app` bundle.)
             * **Linux**: unzip and run `./Companion.Desktop` (chmod +x if needed).
           files: ./release_files/*

.github/workflows/gen-test-coverage-report.yml

@@ -4,8 +4,6 @@ concurrency:
   group: coverage-${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
-# Runs on master branch commits,
-# every commit in a pull request, any published release.
 on:
   workflow_dispatch:
   push:
@@ -17,7 +15,6 @@ on:
 
 jobs:
   coverage:
-    # Minimal permissions; bump only if you actually need more
     permissions:
       contents: read
       pull-requests: write
@@ -36,20 +33,18 @@ jobs:
         with:
           dotnet-version: '8.0.x'
 
-      # If you rely on workloads (e.g., MAUI/Avalonia workloads), keep this.
-      # It can be slow; remove if not needed.
+      # Keep only if you truly need workloads (often you don't for unit tests)
       - name: Restore workloads
         run: dotnet workload restore
 
-      # ---- Project path updates (OpenIPC_Config -> Companion.Desktop) ----
       - name: Restore dependencies
         run: dotnet restore Companion.Desktop/Companion.Desktop.csproj
 
       - name: Build project
         run: dotnet build Companion.Desktop/Companion.Desktop.csproj --configuration Release --no-restore
 
       - name: Run tests with coverage
-        run: dotnet test Companion.Tests/Companion.Tests.csproj --configuration Release --verbosity normal --logger "trx" --collect:"XPlat Code Coverage"
+        run: dotnet test Companion.Tests/Companion.Tests.csproj --configuration Release --no-build --verbosity normal --logger "trx" --collect:"XPlat Code Coverage"
 
       - name: Combine Coverage Reports
         uses: danielpalme/ReportGenerator-GitHub-Action@5.2.4
@@ -83,8 +78,8 @@ jobs:
           thresholds: "10 30"
 
       - name: Add Coverage PR Comment
-        uses: marocchino/sticky-pull-request-comment@v2
         if: github.event_name == 'pull_request'
+        uses: marocchino/sticky-pull-request-comment@v2
         with:
           recreate: true
           path: code-coverage-results.md
@@ -98,12 +93,11 @@ jobs:
           retention-days: 3
 
       - name: Publish Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v2.16.1
         if: always()
+        uses: EnricoMi/publish-unit-test-result-action@v2.16.1
         with:
           trx_files: "${{ github.workspace }}/**/*.trx"
 
-      # Cleanup: use find (rm -rf with ** globs is unreliable in bash)
       - name: Cleanup Disk Space
         if: always()
         shell: bash
@@ -113,8 +107,6 @@ jobs:
           find "${{ github.workspace }}" -type f -name "*.cobertura.xml" -delete || true
           rm -f "${{ github.workspace }}/Cobertura.xml" "${{ github.workspace }}/code-coverage-results.md" || true
 
-      # Optional: pruning artifacts requires extra perms and can be flaky.
-      # Keeping it, but scoping it to non-PR events avoids unnecessary API calls.
       - name: Prune Old Artifacts
         if: always() && github.event_name != 'pull_request'
         uses: c-hive/gha-remove-artifacts@v1

Companion.Desktop/Companion.Desktop.csproj

@@ -11,9 +11,23 @@
         <RootNamespace>Companion.Desktop</RootNamespace>
         <AssemblyName>Companion.Desktop</AssemblyName>
         <UseAppHost>true</UseAppHost>
-        <MacCatalystIcon>Assets/Icons/OpenIPC.icns</MacCatalystIcon>
+        <MacCatalystIcon>..\Companion\Assets\Icons\OpenIPC.icns</MacCatalystIcon>
     </PropertyGroup>
 
+    <Target Name="WriteVersionFile" AfterTargets="Build">
+        <ItemGroup>
+            <_VersionFileLines Include="v$(InformationalVersion)" />
+        </ItemGroup>
+        <WriteLinesToFile File="$(OutputPath)VERSION" Lines="@(_VersionFileLines)" Overwrite="true" />
+    </Target>
+
+    <Target Name="WriteVersionFileForPublish" AfterTargets="Publish">
+        <ItemGroup>
+            <_VersionFileLines Include="v$(InformationalVersion)" />
+        </ItemGroup>
+        <WriteLinesToFile File="$(PublishDir)VERSION" Lines="@(_VersionFileLines)" Overwrite="true" />
+    </Target>
+
     <PropertyGroup>
         <ApplicationManifest>app.manifest</ApplicationManifest>
     </PropertyGroup>

Companion.Tests/Companion.Tests.csproj

@@ -13,7 +13,7 @@
         <PackageReference Include="Avalonia.Desktop" Version="0.10.13"/>
         <PackageReference Include="Avalonia.Svg.Skia" Version="11.2.0.2"/>
         <PackageReference Include="Avalonia.Xaml.Interactivity" Version="11.2.0.12" />
-        <PackageReference Include="coverlet.collector" Version="6.0.0"/>
+        <PackageReference Include="coverlet.collector" Version="6.0.4"/>
         <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.2" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.0"/>
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>

Companion.Tests/Services/UpdateCheckerTests.cs

@@ -51,4 +51,36 @@ public async Task CheckForUpdateAsync_ShouldReturnUpdateAvailable_WhenNewVersion
         Assert.That(result.DownloadUrl, Is.EqualTo("https://example.com/download"));
         Assert.That(result.NewVersion, Is.EqualTo("release-v1.2.0"));
     }
-}
+
+    [Test]
+    public async Task CheckForUpdateAsync_HandlesBuildMetadataInCurrentVersion()
+    {
+        // Arrange
+        var mockHttpMessageHandler = new Mock<HttpMessageHandler>();
+        mockHttpMessageHandler
+            .Protected()
+            .Setup<Task<HttpResponseMessage>>(
+                "SendAsync",
+                ItExpr.IsAny<HttpRequestMessage>(),
+                ItExpr.IsAny<CancellationToken>())
+            .ReturnsAsync(new HttpResponseMessage
+            {
+                StatusCode = HttpStatusCode.OK,
+                Content = new StringContent(MockUpdateJson)
+            });
+
+        var mockHttpClient = new HttpClient(mockHttpMessageHandler.Object);
+
+        var mockConfiguration = new Mock<IConfiguration>();
+        mockConfiguration.Setup(c => c["UpdateChecker:LatestJsonUrl"]).Returns("https://mock-url/latest.json");
+
+        var updateChecker = new UpdateChecker(mockHttpClient, mockConfiguration.Object);
+
+        // Act
+        var result = await updateChecker.CheckForUpdateAsync("v0.0.1+githash");
+
+        // Assert
+        Assert.That(result.HasUpdate, Is.True);
+        Assert.That(result.NewVersion, Is.EqualTo("release-v1.2.0"));
+    }
+}

Companion.Tests/Services/VersionHelperTests.cs

@@ -1,5 +1,6 @@
 using Moq;
 using Companion.Services;
+using System.Reflection;
 
 namespace OpenIPC.Companion.Tests.Services;
 
@@ -27,10 +28,10 @@ public void GetAppVersion_ReturnsVersionFromFile_InDevelopmentEnvironment()
     {
         // Arrange
         Environment.SetEnvironmentVariable("ASPNETCORE_ENVIRONMENT", "Development");
-        var expectedVersion = "1.0.0-test";
+        var expectedVersion = "v1.0.0-test";
 
         _mockFileSystem.Setup(fs => fs.Exists(It.IsAny<string>())).Returns(true);
-        _mockFileSystem.Setup(fs => fs.ReadAllText(It.IsAny<string>())).Returns(expectedVersion);
+        _mockFileSystem.Setup(fs => fs.ReadAllText(It.IsAny<string>())).Returns("1.0.0-test");
 
         // Act
         var version = VersionHelper.GetAppVersion();
@@ -53,4 +54,27 @@ public void GetAppVersion_ReturnsUnknownVersion_OnException()
         // Assert
         Assert.That(version, Is.EqualTo("Unknown Version"));
     }
-}
+
+    [Test]
+    public void GetAppVersion_ReturnsAssemblyVersion_WhenFileMissing()
+    {
+        // Arrange
+        _mockFileSystem.Setup(fs => fs.Exists(It.IsAny<string>())).Returns(false);
+        var targetAssembly = typeof(VersionHelper).Assembly;
+        var informationalVersion = targetAssembly
+            .GetCustomAttribute<AssemblyInformationalVersionAttribute>()?
+            .InformationalVersion;
+        var assemblyVersion = targetAssembly.GetName().Version?.ToString();
+
+        // Act
+        var version = VersionHelper.GetAppVersion();
+
+        // Assert
+        var expected = !string.IsNullOrWhiteSpace(informationalVersion)
+            ? $"v{informationalVersion}"
+            : $"v{assemblyVersion}";
+
+        Assert.That(expected, Is.Not.Null.And.Not.Empty);
+        Assert.That(version, Is.EqualTo(expected));
+    }
+}