Merge pull request #3 from ConvertAPI/release-automation

Release automation and documentation

Author: tomasr78

.github/workflows/release.yml

@@ -1,48 +1,80 @@
-name: Build and Package
+name: Build and Release
 
 on:
   workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version tag (e.g. v1.0.0)'
+        required: true
+        default: 'v1.0.0'
   push:
     tags:
       - 'v*'
 
 jobs:
-  build:
+  create_release_job:
     runs-on: ubuntu-latest
-    timeout-minutes: 30
-    env:
-      GITHUB_ACTIONS: true
-      PUBLISH_DIR: bin/Release/net8.0/win-x64/publish
-      OUTPUT_ZIP: output/convertApi-cli.zip
-
+    outputs:
+      release_upload_url: ${{ steps.create_release.outputs.upload_url }}
     steps:
-      # Checkout the code
       - name: Checkout
         uses: actions/checkout@v4
-
-      # Setup .NET SDK
+        
       - name: Setup .NET SDK
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: '8.x'
 
-      # Run tests
       - name: Test
         run: dotnet test ConvertApi.Cli.Tests
 
-      # Build the project
-      - name: Build
-        run: dotnet publish -c Release -r win-x64 --self-contained true /p:PublishSingleFile=true /p:IncludeNativeLibrariesForSelfExtract=true
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.event.inputs.version || github.ref_name }}
+          release_name: ${{ github.event.inputs.version || github.ref_name }}
+          draft: false
+          prerelease: false
+
+  build_and_upload:
+    runs-on: ubuntu-latest
+    needs: create_release_job
+    strategy:
+      matrix:
+        runtime: [ "win-x64", "linux-x64", "linux-arm64", "osx-x64", "osx-arm64" ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.x'
+
+      - name: Publish for ${{ matrix.runtime }}
+        run: |
+          dotnet publish ConvertApi.Cli/ConvertApi.Cli.csproj \
+            -c Release \
+            -r ${{ matrix.runtime }} \
+            --self-contained true \
+            /p:PublishSingleFile=true \
+            /p:IncludeNativeLibrariesForSelfExtract=true \
+            /p:DebugType=none \
+            /p:DebugSymbols=false
 
-      # Create a zip package
-      - name: Create ZIP package
+      - name: Zip package
         run: |
-          mkdir -p output
-          zip -j ${{ env.OUTPUT_ZIP }} ${{ env.PUBLISH_DIR }}/*
+          zip -j convertApi-cli-${{ matrix.runtime }}.zip ConvertApi.Cli/bin/Release/net8.0/${{ matrix.runtime }}/publish/*
 
-      # Upload the artifact
-      - name: Upload artifact
-        uses: actions/upload-artifact@v3
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          name: convertApi-cli
-          path: ${{ env.OUTPUT_ZIP }}
+          upload_url: ${{ needs.create_release_job.outputs.release_upload_url }}
+          asset_path: ./convertApi-cli-${{ matrix.runtime }}.zip
+          asset_name: convertApi-cli-${{ matrix.runtime }}.zip
+          asset_content_type: application/zip

ConvertApi.Cli.Test/CliTests.cs ConvertApi.Cli.Tests/CliTests.csConvertApi.Cli.Test/CliTests.cs renamed to ConvertApi.Cli.Tests/CliTests.cs

@@ -1,11 +1,10 @@
 using System.Diagnostics;
 
-namespace ConvertApi.Cli.Test;
+namespace ConvertApi.Cli.Tests;
 
 [TestFixture]
 public class CliTests
 {
-    private static readonly string CliExecutablePath = Path.Combine(Directory.GetCurrentDirectory(), "convertapi-cli.exe");
     private const string ApiToken = "token_ST4z2qhE"; // Provide your API token
     private static readonly string TestOutputDir = Path.Combine(Directory.GetCurrentDirectory(), "test_output");
 
@@ -67,14 +66,15 @@ public void TestProtectPdfWithPassword()
 
     private Process RunCli(string arguments)
     {
-        if (!File.Exists(CliExecutablePath))
-            throw new FileNotFoundException($"CLI executable not found at {CliExecutablePath}");
+        var cliExecutablePath = GetCliExecutablePath();
+        if (!File.Exists(cliExecutablePath))
+            throw new FileNotFoundException($"CLI executable not found at {cliExecutablePath}");
 
         var process = new Process
         {
             StartInfo = new ProcessStartInfo
             {
-                FileName = CliExecutablePath,
+                FileName = cliExecutablePath,
                 Arguments = arguments,
                 UseShellExecute = true, // Run in a normal console environment, because otherwise process hangs because of readline in program.cs
                 CreateNoWindow = true 
@@ -96,4 +96,25 @@ private Process RunCli(string arguments)
 
         return process;
     }
+    
+    private string GetCliExecutablePath()
+    {
+        var executableName = Path.Combine(Directory.GetCurrentDirectory(), "convertapi-cli");
+        if (OperatingSystem.IsWindows())
+        {
+            executableName += ".exe";
+        }
+
+        var path = Path.Combine(
+            AppContext.BaseDirectory, 
+            executableName
+        );
+
+        if (!File.Exists(path))
+        {
+            throw new FileNotFoundException($"CLI executable not found at {path}");
+        }
+
+        return path;
+    }
 }

…st/ContentDispositionHeaderValueTests.cs …ts/ContentDispositionHeaderValueTests.csConvertApi.Cli.Test/ContentDispositionHeaderValueTests.cs renamed to ConvertApi.Cli.Tests/ContentDispositionHeaderValueTests.cs ConvertApi.Cli.Test/ContentDispositionHeaderValueTests.cs renamed to ConvertApi.Cli.Tests/ContentDispositionHeaderValueTests.cs

@@ -1,6 +1,6 @@
 using Microsoft.Net.Http.Headers;
 
-namespace ConvertApi.Cli.Test;
+namespace ConvertApi.Cli.Tests;
 
 [TestFixture]
 public class ContentDispositionHeaderValueTests

…tApi.Cli.Test/ConvertApi.Cli.Test.csproj …pi.Cli.Tests/ConvertApi.Cli.Tests.csprojConvertApi.Cli.Test/ConvertApi.Cli.Test.csproj renamed to ConvertApi.Cli.Tests/ConvertApi.Cli.Tests.csproj ConvertApi.Cli.Test/ConvertApi.Cli.Test.csproj renamed to ConvertApi.Cli.Tests/ConvertApi.Cli.Tests.csproj

@@ -7,6 +7,7 @@
 
         <IsPackable>false</IsPackable>
         <IsTestProject>true</IsTestProject>
+        <RootNamespace>ConvertApi.Cli.Tests</RootNamespace>
     </PropertyGroup>
 
     <ItemGroup>

ConvertApi.Cli.Test/DirectCallTests.cs ConvertApi.Cli.Tests/DirectCallTests.csConvertApi.Cli.Test/DirectCallTests.cs renamed to ConvertApi.Cli.Tests/DirectCallTests.cs

@@ -1,4 +1,4 @@
-namespace ConvertApi.Cli.Test;
+namespace ConvertApi.Cli.Tests;
 
 [TestFixture]
 public class DirectCallTests

ConvertApi.Cli.sln

@@ -2,7 +2,7 @@
 Microsoft Visual Studio Solution File, Format Version 12.00
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConvertApi.Cli", "ConvertApi.Cli\ConvertApi.Cli.csproj", "{006B1430-754B-46E0-BF11-2B9A759E6611}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConvertApi.Cli.Test", "ConvertApi.Cli.Test\ConvertApi.Cli.Test.csproj", "{B14DD22A-6CF3-4515-BFCB-7A7FDE5FD036}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConvertApi.Cli.Tests", "ConvertApi.Cli.Tests\ConvertApi.Cli.Tests.csproj", "{B14DD22A-6CF3-4515-BFCB-7A7FDE5FD036}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

ConvertApi.Cli/ConvertApi.Cli.csproj

@@ -12,6 +12,11 @@
         <EnableCompressionInSingleFile>true</EnableCompressionInSingleFile>-->
         <AssemblyName>convertapi-cli</AssemblyName>
         <RootNamespace>ConvertApi.Cli</RootNamespace>
+        <Authors>ConvertAPI</Authors>
+        <Description>convertapi-cli</Description>
+        <Copyright>ConvertAPI</Copyright>
+        <Company>ConvertAPI</Company>
+        <Version>0.0.1</Version>
     </PropertyGroup>
 
     <ItemGroup>

ConvertApi.Cli/Program.cs

@@ -79,7 +79,7 @@ static void DisplayHelp()
         Console.WriteLine("ConvertAPI provides a simple way to convert files between different formats, merge, and apply transformations using its powerful API.");
         Console.WriteLine();
         Console.WriteLine("Usage:");
-        Console.WriteLine("  convertapi-cli.exe <api-token> <output-file> <input-files...> [from-format] [to-format] [key1=value1 key2=value2 ...]");
+        Console.WriteLine("  convertapi-cli.exe <api-token> <output-directory> <input-files...> [from-format] [to-format] [key1=value1 key2=value2 ...]");
         Console.WriteLine();
         Console.WriteLine("Examples:");
         Console.WriteLine("  Convert a single PDF to DOCX:");