🐛 harmonize OS names across clients (#330)

Author: ianardee

.github/workflows/publish.yml renamed to .github/workflows/_publish-code.yml

@@ -1,11 +1,11 @@
 #
 # Publish releases to NPM
 #
-name: Publish
+name: Publish Code
 
 on:
-  release:
-    types: [ published ]
+  workflow_call:
+  workflow_dispatch:
 
 jobs:
   publish:

.github/workflows/docs.yml renamed to .github/workflows/_publish-docs.yml

@@ -1,15 +1,15 @@
-name: Documentation
+#
+# Publish Documentation to GitHub pages.
+#
+name: Publish Documentation
 
 on:
-  release:
-    types: [ published ]
-
-  # Allows running this workflow manually from the Actions tab
+  workflow_call:
   workflow_dispatch:
 
 jobs:
-  publish-docs:
-    name: Publish Docs
+  documentation:
+    name: Publish Documentation
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/_publish-guide.yml

@@ -0,0 +1,10 @@
+name: Publish Guide to readme.com
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  sync:
+    uses: mindee/client-lib-actions/.github/workflows/publish-guide.yml@main
+    secrets: inherit

.github/workflows/publish-release.yml

@@ -0,0 +1,17 @@
+name: Publish Release
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  publish_docs:
+    uses: mindee/mindee-api-nodejs/.github/workflows/_publish-docs.yml@main
+    secrets: inherit
+  publish_guide:
+    uses: mindee/mindee-api-nodejs/.github/workflows/_publish-guide.yml@main
+    needs: publish_docs
+    secrets: inherit
+  publish_code:
+    uses: mindee/mindee-api-nodejs/.github/workflows/_publish-code.yml@main
+    secrets: inherit

.github/workflows/push-main-branch.yml

@@ -0,0 +1,10 @@
+name: Push Main Branch
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tag:
+    uses: mindee/client-lib-actions/.github/workflows/tag-version.yml@main

.github/workflows/sync-readme.yml

@@ -6,13 +6,18 @@ on:
 jobs:
   run-tests:
     name: Run Integration Tests
-    runs-on: ubuntu-latest
+    timeout-minutes: 30
     strategy:
+      max-parallel: 4
       matrix:
+        os:
+          - "ubuntu-latest"
+          - "windows-latest"
+          - "macos-latest"
         node-version:
           - "18"
-          - "20"
           - "22"
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Check out Git repository

.github/workflows/test-integration.yml renamed to .github/workflows/test-integrations.yml

@@ -6,13 +6,16 @@ on:
 jobs:
   run-tests:
     name: Run Tests
-    runs-on: ubuntu-latest
     strategy:
+      max-parallel: 4
       matrix:
+        os:
+          - "ubuntu-latest"
         node-version:
           - "18"
           - "20"
           - "22"
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Check out Git repository

.github/workflows/test.yml renamed to .github/workflows/test-units.yml

@@ -13,10 +13,6 @@ interface MindeeApiConstructorProps {
   apiKey: string;
 }
 
-const USER_AGENT: string = `mindee-api-nodejs@v${sdkVersion} nodejs-${
-  process.version
-} ${os.type().toLowerCase()}`;
-
 export class ApiSettings {
   apiKey: string;
   baseHeaders: Record<string, string>;
@@ -38,13 +34,29 @@ export class ApiSettings {
       );
     }
     this.baseHeaders = {
-      "User-Agent": USER_AGENT,
+      "User-Agent": this.getUserAgent(),
       Authorization: `Token ${this.apiKey}`,
     };
     this.hostname = this.hostnameFromEnv();
     this.timeout = process.env.MINDEE_REQUEST_TIMEOUT ? parseInt(process.env.MINDEE_REQUEST_TIMEOUT) : TIMEOUT_DEFAULT;
   }
 
+  protected getUserAgent(): string {
+    let platform = os.type().toLowerCase();
+    if (platform.includes("darwin")) {
+      platform = "macos";
+    }
+    else if (platform.includes("window")) {
+      platform = "windows";
+    }
+    else if (platform.includes("bsd")) {
+      platform = "bsd";
+    }
+    return `mindee-api-nodejs@v${sdkVersion} nodejs-${
+      process.version
+    } ${platform}`;
+  }
+
   protected apiKeyFromEnv(): string {
     const envVarValue = process.env[API_KEY_ENVVAR_NAME];
     if (envVarValue) {