Fix/ice-1010 improvement

.github/actions/sanitized-branch-name/action.yml

@@ -0,0 +1,22 @@
+---
+name: 'Detect TARGET_DIR'
+description: 'Detects the target directory based on the branch name'
+outputs:
+  target_dir:
+    description: 'The target directory'
+    value: ${{ steps.detect-target-dir.outputs.target_dir }}
+runs:
+  using: 'composite'
+  steps:
+    - name: Detect TARGET_DIR
+      id: detect-target-dir
+      shell: bash
+      run: |
+        BRANCH_NAME=${GITHUB_REF##*/}
+        SANITIZED_BRANCH_NAME=$(echo $BRANCH_NAME | tr '/' '-')
+        echo "TARGET_DIR=${{ inputs.docs_prefix }}-$SANITIZED_BRANCH_NAME" >> $GITHUB_ENV
+        echo "target_dir=${{ inputs.docs_prefix }}-$SANITIZED_BRANCH_NAME" >> $GITHUB_OUTPUT
+inputs:
+  docs_prefix:
+    description: 'Prefix for the documentation directory'
+    required: true

.github/workflows/build-bundle.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version-file: '.nvmrc'
       - name: Install dependencies and build
         run: npm run install-and-build-all
       - name: Set environment variable for head ref

.github/workflows/deploy-js-docs.yml

@@ -0,0 +1,104 @@
+---
+name: deploy-js-docs
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  js-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Clean up existing artifacts
+        run: rm -rf docs
+
+      - name: Run jsdocs generation
+        run: npm run docs
+
+      - name: Upload jsdocs report
+        uses: actions/upload-artifact@v3
+        with:
+          name: jsdocs-report
+          path: docs
+
+  deploy-js-docs:
+    needs: js-docs
+    runs-on: ubuntu-latest
+    env:
+      DOCS_PREFIX: "jsdocs"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure Git
+        run: |
+          git config --global user.email "github-actions@github.com"
+          git config --global user.name "GitHub Actions"
+
+      - name: Fetch all branches
+        run: git fetch --all
+
+      - name: Checkout gh-pages branch
+        run: git checkout gh-pages
+
+      - name: Detect TARGET_DIR
+        id: detect-target-dir
+        run: |
+          BRANCH_NAME=${GITHUB_REF##*/}
+          SANITIZED_BRANCH_NAME=$(echo $BRANCH_NAME | tr '/' '-')
+          echo "TARGET_DIR=${{ env.DOCS_PREFIX }}-$SANITIZED_BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: delete existing coverage folder
+        env:
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+        run: |
+          rm -rf "$TARGET_DIR"
+          rm -rf docs
+
+
+      - name: Download jsdocs report
+        uses: actions/download-artifact@v3
+        with:
+          name: jsdocs-report
+          path: docs
+
+      - name: Copy new docs to gh-pages
+        run: |
+          mkdir -p "$TARGET_DIR"
+          cp -r docs/* "$TARGET_DIR/"
+          git add .
+          git commit -m "Deploy js docs report for branch $BRANCH_NAME" || true
+          git push origin gh-pages || true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+
+      - name: Print Coverage Report URL
+        id: print-url
+        env:
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+        run: |
+          REPOSITORY_OWNER=${{ github.repository_owner }}
+          REPOSITORY_NAME=${{ github.event.repository.name }}
+          BRANCH_NAME=${GITHUB_REF##*/}
+          SANITIZED_BRANCH_NAME=$(echo $BRANCH_NAME | tr '/' '-')
+          URL="https://$REPOSITORY_OWNER.github.io/$REPOSITORY_NAME/$TARGET_DIR/"
+          echo "It is deployed to: $URL"
+          echo "url=$URL" >> $GITHUB_OUTPUT
+
+      - name: Add Coverage Report URL to Job Summary
+        run: |
+          echo "[${{ steps.print-url.outputs.url }}](${{ steps.print-url.outputs.url }})" >> $GITHUB_STEP_SUMMARY

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

@@ -0,0 +1,104 @@
+---
+name: deploy-test-coverage-report
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Clean up existing artifacts
+        run: rm -rf coverage
+
+      - name: Run tests with coverage
+        run: npm run test:coverage
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: coverage/lcov-report
+
+  deploy-coverage:
+    needs: unit-tests
+    runs-on: ubuntu-latest
+    env:
+      DOCS_PREFIX: 'coverage'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure Git
+        run: |
+          git config --global user.email "github-actions@github.com"
+          git config --global user.name "GitHub Actions"
+
+      - name: Fetch all branches
+        run: git fetch --all
+
+      - name: Checkout gh-pages branch
+        run: git checkout gh-pages
+
+      - name: Detect TARGET_DIR
+        id: detect-target-dir
+        run: |
+          BRANCH_NAME=${GITHUB_REF##*/}
+          SANITIZED_BRANCH_NAME=$(echo $BRANCH_NAME | tr '/' '-')
+          echo "TARGET_DIR=${{ env.DOCS_PREFIX }}-$SANITIZED_BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: delete existing coverage folder
+        env:
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+        run: |
+          rm -rf "$TARGET_DIR"
+          rm -rf coverage
+
+      - name: Download coverage report
+        uses: actions/download-artifact@v3
+        with:
+          name: coverage-report
+          path: coverage
+
+      - name: Copy new coverage to coverage folder
+        env:
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          mkdir -p "$TARGET_DIR"
+          cp -r coverage/* "$TARGET_DIR/"
+          git add .
+          git commit -m "Deploy js docs report for branch $BRANCH_NAME" || true
+          git push origin gh-pages || true
+
+
+      - name: Print Coverage Report URL
+        id: print-url
+        env:
+          TARGET_DIR: ${{ env.TARGET_DIR }}
+        run: |
+          REPOSITORY_OWNER=${{ github.repository_owner }}
+          REPOSITORY_NAME=${{ github.event.repository.name }}
+          BRANCH_NAME=${GITHUB_REF##*/}
+          SANITIZED_BRANCH_NAME=$(echo $BRANCH_NAME | tr '/' '-')
+          URL="https://$REPOSITORY_OWNER.github.io/$REPOSITORY_NAME/$TARGET_DIR/"
+          echo "It is deployed to: $URL"
+          echo "url=$URL" >> $GITHUB_OUTPUT
+
+      - name: Add Coverage Report URL to Job Summary
+        run: |
+          echo "[${{ steps.print-url.outputs.url }}](${{ steps.print-url.outputs.url }})" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -13,9 +13,11 @@ logs/
 # Local History for Visual Studio Code
 .history/
 **/node_modules/
+node_modules/
+**/coverage/
 # Built Visual Studio Code Extensions
 *.vsix
-
+docs/
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 

.nvmrc

@@ -0,0 +1 @@
+20

.pre-commit-config.yaml

@@ -35,7 +35,7 @@ repos:
   # Standard pre-commit-hooks for general all-purpose formatting and validation
   # -----------------------------
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.16.0
+    rev: v9.18.0
     hooks:
       - id: commitlint
         stages: [commit-msg]
@@ -48,7 +48,7 @@ repos:
   #   some_non_secret_value = a1b2c3d4e5f6g7h8i9j0 # gitleaks:allow
   # -----------------------------
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.18.4
+    rev: v8.19.2
     hooks:
       - id: gitleaks
   # -----------------------------

check-commit-message/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "check-commit-message",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@actions/core": "^1.10.1",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^6.0.0"
+  }
+}