@devopsplaybook.io/common-utils 1.0.0-beta.5.18ca754

package/.github/workflows/main-build.yml

@@ -0,0 +1,17 @@
+name: Main Build
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+jobs:
+  npm-merge:
+    uses: devopsplaybook-io/common-utils/.github/workflows/reusable-npm-merge.yml@main
+    with:
+      npm_package_name: "@devopsplaybook.io/common-utils"
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      QUALITY_DASHBOARD_URL: ${{ secrets.QUALITY_DASHBOARD_URL }}
+      QUALITY_DASHBOARD_TOKEN: ${{ secrets.QUALITY_DASHBOARD_TOKEN }}

package/.github/workflows/npm-upgrade.yml

@@ -0,0 +1,16 @@
+name: NPM Upgrade
+
+on:
+  schedule:
+    - cron: "0 6 * * 1"
+
+  workflow_dispatch:
+
+jobs:
+  npm-upgrade:
+    uses: devopsplaybook-io/common-utils/.github/workflows/reusable-npm-upgrade.yml@main
+    permissions:
+      contents: write
+      pull-requests: write
+    with:
+      npm_services: "[]"

package/.github/workflows/pr-check.yml

@@ -0,0 +1,26 @@
+name: PR Check
+
+on:
+  pull_request:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+concurrency:
+  group: pr-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+
+jobs:
+  npm-pr:
+    uses: devopsplaybook-io/common-utils/.github/workflows/reusable-npm-pr.yml@main
+    with:
+      npm_package_name: "@devopsplaybook.io/common-utils"
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      QUALITY_DASHBOARD_URL: ${{ secrets.QUALITY_DASHBOARD_URL }}
+      QUALITY_DASHBOARD_TOKEN: ${{ secrets.QUALITY_DASHBOARD_TOKEN }}

package/.github/workflows/reusable-merge-build.yml

@@ -0,0 +1,141 @@
+name: "Reusable: Merge Build"
+
+on:
+  workflow_call:
+    inputs:
+      docker_platforms:
+        description: "Docker platforms to build for"
+        required: false
+        type: string
+        default: "linux/arm64/v8,linux/amd64"
+      node_app_directories:
+        description: "JSON array of Node.js app directories to build, lint, and test"
+        required: false
+        type: string
+        default: ""
+      node_version:
+        description: "Node.js version to use"
+        required: false
+        type: string
+        default: "22"
+    secrets:
+      DOCKER_HUB_USERNAME:
+        required: true
+      DOCKER_HUB_ACCESS_TOKEN:
+        required: true
+      QUALITY_DASHBOARD_TOKEN:
+        required: false
+      QUALITY_DASHBOARD_URL:
+        required: false
+
+jobs:
+  node-build:
+    if: inputs.node_app_directories != ''
+    strategy:
+      matrix:
+        app: ${{ fromJSON(inputs.node_app_directories) }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ matrix.app }}
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+          cache: "npm"
+          cache-dependency-path: ${{ matrix.app }}/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test
+        run: npm run test
+
+      - name: Zip coverage and upload to Quality Dashboard
+        if: always()
+        env:
+          QUALITY_DASHBOARD_URL: ${{ secrets.QUALITY_DASHBOARD_URL }}
+          QUALITY_DASHBOARD_TOKEN: ${{ secrets.QUALITY_DASHBOARD_TOKEN }}
+        run: |
+          APP_NAME="${{ matrix.app }}"
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          REPORT_KEY="$(echo "$APP_NAME" | sed 's/[^a-zA-Z0-9._:\-\/]/_/g')_coverage"
+
+          if [ -d coverage ]; then
+            if [ -z "$QUALITY_DASHBOARD_URL" ] || [ -z "$QUALITY_DASHBOARD_TOKEN" ]; then
+              echo "Quality Dashboard URL or token not set, skipping upload"
+              exit 0
+            fi
+            # Zip coverage contents at root level so the jest processor
+            # finds coverage-final.json / clover.xml directly
+            (cd coverage && zip -r "${{ runner.temp }}/coverage.zip" .)
+
+            META=$(jq -n \
+              --arg key "$REPORT_KEY" \
+              --arg pkg "$PACKAGE_NAME" \
+              '{
+                key: $key,
+                displayName: "Coverage: \($pkg)",
+                processor: "jest"
+              }')
+
+            echo "Uploading coverage: $REPORT_KEY"
+            HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+              -X POST "$QUALITY_DASHBOARD_URL/api/reports/" \
+              -H "x-upload-token: $QUALITY_DASHBOARD_TOKEN" \
+              -F "meta=$META" \
+              -F "file=@${{ runner.temp }}/coverage.zip" \
+              --max-time 30)
+
+            if [ "$HTTP_CODE" = "201" ]; then
+              echo "\u2713 Coverage uploaded ($HTTP_CODE)"
+            else
+              echo "\u26a0 Upload returned HTTP $HTTP_CODE"
+            fi
+          else
+            echo "No coverage/ directory found, skipping upload"
+          fi
+
+  docker-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Build and Push Docker Image
+        run: |
+          set -e
+          SERVICE_NAME=$(cat package.json | jq -r '.name')
+          SERVICE_VERSION=$(cat package.json | jq -r '.version')
+          SERVICE_VERSION_MAJOR=$(echo "${SERVICE_VERSION}" | cut -f1 -d".")
+          SERVICE_VERSION_MINOR=$(echo "${SERVICE_VERSION}" | cut -f1-2 -d".")
+          echo "Building ${SERVICE_NAME}:${SERVICE_VERSION}"
+          docker buildx build \
+            --platform ${{ inputs.docker_platforms }} \
+            --push \
+            -f Dockerfile \
+            -t ${{ secrets.DOCKER_HUB_USERNAME }}/${SERVICE_NAME}:latest \
+            -t ${{ secrets.DOCKER_HUB_USERNAME }}/${SERVICE_NAME}:${SERVICE_VERSION} \
+            -t ${{ secrets.DOCKER_HUB_USERNAME }}/${SERVICE_NAME}:${SERVICE_VERSION_MAJOR} \
+            -t ${{ secrets.DOCKER_HUB_USERNAME }}/${SERVICE_NAME}:${SERVICE_VERSION_MINOR} \
+            .

package/.github/workflows/reusable-npm-merge.yml

@@ -0,0 +1,135 @@
+name: "Reusable: NPM Merge"
+
+on:
+  workflow_call:
+    inputs:
+      node_version:
+        description: "Node.js version to use"
+        required: false
+        type: string
+        default: "18"
+      npm_package_name:
+        description: "NPM package name (e.g. @devopsplaybook.io/otel-utils)"
+        required: true
+        type: string
+    secrets:
+      NPM_TOKEN:
+        required: true
+      QUALITY_DASHBOARD_TOKEN:
+        required: false
+      QUALITY_DASHBOARD_URL:
+        required: false
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linting
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Zip coverage and upload to Quality Dashboard
+        if: always()
+        env:
+          QUALITY_DASHBOARD_URL: ${{ secrets.QUALITY_DASHBOARD_URL }}
+          QUALITY_DASHBOARD_TOKEN: ${{ secrets.QUALITY_DASHBOARD_TOKEN }}
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          REPORT_KEY=$(echo "$PACKAGE_NAME" | sed 's/[^a-zA-Z0-9._:\-\/]/_/g')
+          REPORT_KEY="${REPORT_KEY}_coverage"
+
+          if [ -d coverage ]; then
+            if [ -z "$QUALITY_DASHBOARD_URL" ] || [ -z "$QUALITY_DASHBOARD_TOKEN" ]; then
+              echo "Quality Dashboard URL or token not set, skipping upload"
+              exit 0
+            fi
+            # Zip coverage contents at root level so the jest processor
+            # finds coverage-final.json / clover.xml directly
+            (cd coverage && zip -r "${{ runner.temp }}/coverage.zip" .)
+
+            META=$(jq -n \
+              --arg key "$REPORT_KEY" \
+              --arg pkg "$PACKAGE_NAME" \
+              '{
+                key: $key,
+                displayName: "Coverage: \($pkg)",
+                processor: "jest"
+              }')
+
+            echo "Uploading coverage: $REPORT_KEY"
+            HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+              -X POST "$QUALITY_DASHBOARD_URL/api/reports/" \
+              -H "x-upload-token: $QUALITY_DASHBOARD_TOKEN" \
+              -F "meta=$META" \
+              -F "file=@${{ runner.temp }}/coverage.zip" \
+              --max-time 30)
+
+            if [ "$HTTP_CODE" = "201" ]; then
+              echo "\u2713 Coverage uploaded ($HTTP_CODE)"
+            else
+              echo "\u26a0 Upload returned HTTP $HTTP_CODE"
+            fi
+          else
+            echo "No coverage/ directory found, skipping upload"
+          fi
+
+      - name: Build package
+        run: npm run build
+
+  publish-release:
+    runs-on: ubuntu-latest
+    needs: test-and-build
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
+
+      - name: Check if version changed
+        id: version-check
+        run: |
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          echo "current-version=${CURRENT_VERSION}" >> $GITHUB_OUTPUT
+
+          if npm view ${{ inputs.npm_package_name }}@${CURRENT_VERSION} version &> /dev/null; then
+            echo "version-exists=true" >> $GITHUB_OUTPUT
+            echo "Version ${CURRENT_VERSION} already exists on npm"
+          else
+            echo "version-exists=false" >> $GITHUB_OUTPUT
+            echo "Version ${CURRENT_VERSION} is new, will publish"
+          fi
+
+      - name: Publish release package
+        if: steps.version-check.outputs.version-exists == 'false'
+        run: |
+          echo "Publishing version ${{ steps.version-check.outputs.current-version }}"
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/reusable-npm-pr.yml

@@ -0,0 +1,153 @@
+name: "Reusable: NPM PR"
+
+on:
+  workflow_call:
+    inputs:
+      node_version:
+        description: "Node.js version to use"
+        required: false
+        type: string
+        default: "18"
+      npm_package_name:
+        description: "NPM package name (e.g. @devopsplaybook.io/otel-utils)"
+        required: true
+        type: string
+    secrets:
+      NPM_TOKEN:
+        required: true
+      QUALITY_DASHBOARD_TOKEN:
+        required: false
+      QUALITY_DASHBOARD_URL:
+        required: false
+
+jobs:
+  test-and-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linting
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Zip coverage and upload to Quality Dashboard
+        if: always()
+        env:
+          QUALITY_DASHBOARD_URL: ${{ secrets.QUALITY_DASHBOARD_URL }}
+          QUALITY_DASHBOARD_TOKEN: ${{ secrets.QUALITY_DASHBOARD_TOKEN }}
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          REPORT_KEY=$(echo "$PACKAGE_NAME" | sed 's/[^a-zA-Z0-9._:\-\/]/_/g')
+          REPORT_KEY="${REPORT_KEY}_coverage"
+
+          if [ -d coverage ]; then
+            if [ -z "$QUALITY_DASHBOARD_URL" ] || [ -z "$QUALITY_DASHBOARD_TOKEN" ]; then
+              echo "Quality Dashboard URL or token not set, skipping upload"
+              exit 0
+            fi
+            # Zip coverage contents at root level so the jest processor
+            # finds coverage-final.json / clover.xml directly
+            (cd coverage && zip -r "${{ runner.temp }}/coverage.zip" .)
+
+            META=$(jq -n \
+              --arg key "$REPORT_KEY" \
+              --arg pkg "$PACKAGE_NAME" \
+              '{
+                key: $key,
+                displayName: "Coverage: \($pkg)",
+                processor: "jest"
+              }')
+
+            echo "Uploading coverage: $REPORT_KEY"
+            HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+              -X POST "$QUALITY_DASHBOARD_URL/api/reports/" \
+              -H "x-upload-token: $QUALITY_DASHBOARD_TOKEN" \
+              -F "meta=$META" \
+              -F "file=@${{ runner.temp }}/coverage.zip" \
+              --max-time 30)
+
+            if [ "$HTTP_CODE" = "201" ]; then
+              echo "\u2713 Coverage uploaded ($HTTP_CODE)"
+            else
+              echo "\u26a0 Upload returned HTTP $HTTP_CODE"
+            fi
+          else
+            echo "No coverage/ directory found, skipping upload"
+          fi
+
+      - name: Build package
+        run: npm run build
+
+  publish-beta:
+    runs-on: ubuntu-latest
+    needs: test-and-build
+    if: github.event_name == 'pull_request'
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
+
+      - name: Generate beta version
+        id: beta-version
+        run: |
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          PR_NUMBER=${{ github.event.pull_request.number }}
+          COMMIT_SHA=${GITHUB_SHA:0:7}
+          BETA_VERSION="${CURRENT_VERSION}-beta.${PR_NUMBER}.${COMMIT_SHA}"
+          echo "version=${BETA_VERSION}" >> $GITHUB_OUTPUT
+          echo "Beta version will be: ${BETA_VERSION}"
+
+      - name: Update package.json with beta version
+        run: |
+          npm version ${{ steps.beta-version.outputs.version }} --no-git-tag-version
+
+      - name: Publish beta package
+        run: npm publish --tag beta
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Comment PR with beta version info
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `🚀 **Beta version published!**
+              
+              **Package**: \`${{ inputs.npm_package_name }}@${{ steps.beta-version.outputs.version }}\`
+              
+              Install with:
+              \`\`\`bash
+              npm install ${{ inputs.npm_package_name }}@${{ steps.beta-version.outputs.version }}
+              # or
+              npm install ${{ inputs.npm_package_name }}@beta
+              \`\`\`
+              
+              This beta version will be available for testing until the PR is merged.`
+            })

package/.github/workflows/reusable-npm-upgrade.yml

@@ -0,0 +1,92 @@
+name: "Reusable: NPM Upgrade"
+
+on:
+  workflow_call:
+    inputs:
+      npm_services:
+        description: "JSON array of sub-folders containing NPM services to update"
+        required: true
+        type: string
+      pr_branch:
+        description: "Branch name for the upgrade PR (defaults to feature/YYYY.MM.DD-dependency-updates)"
+        required: false
+        type: string
+        default: ""
+
+jobs:
+  npm-upgrade:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Resolve branch name
+        id: branch
+        run: |
+          if [ -n "${{ inputs.pr_branch }}" ]; then
+            echo "name=${{ inputs.pr_branch }}" >> $GITHUB_OUTPUT
+          else
+            echo "name=feature/$(date +'%Y.%m.%d')-dependency-updates" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Check for existing PR
+        id: check_pr
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          EXISTING_PR=$(gh pr list --state open --json number --jq 'length')
+          if [ "${EXISTING_PR}" -gt 0 ]; then
+            echo "An open PR already exists, skipping"
+            echo "skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "skip=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Update NPM dependencies
+        if: steps.check_pr.outputs.skip == 'false'
+        run: |
+          set -e
+          # Update root package
+          echo "Updating dependencies in root"
+          npx npm-check-updates -u
+          npm install
+          # Update sub-service packages
+          SERVICES='${{ inputs.npm_services }}'
+          for FOLDER in $(echo "${SERVICES}" | jq -r '.[]'); do
+            echo "Updating dependencies in ${FOLDER}"
+            cd "${FOLDER}"
+            npx npm-check-updates -u
+            npm install
+            cd "${GITHUB_WORKSPACE}"
+          done
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "HAS_CHANGES=true" >> $GITHUB_ENV
+          fi
+
+      - name: Bump root package.json patch version
+        if: steps.check_pr.outputs.skip == 'false' && env.HAS_CHANGES == 'true'
+        run: |
+          set -e
+          CURRENT_VERSION=$(jq -r '.version' package.json)
+          NEW_VERSION=$(echo "${CURRENT_VERSION}" | awk -F. '{print $1"."$2"."$3+1}')
+          jq --arg v "${NEW_VERSION}" '.version = $v' package.json > package.json.tmp && mv package.json.tmp package.json
+          echo "Bumped root package.json version: ${CURRENT_VERSION} -> ${NEW_VERSION}"
+
+      - name: Create Pull Request
+        if: steps.check_pr.outputs.skip == 'false' && env.HAS_CHANGES == 'true'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git checkout -b "${{ steps.branch.outputs.name }}"
+          git add -A
+          git commit -m "chore: update NPM dependencies"
+          git push origin "${{ steps.branch.outputs.name }}"
+          gh pr create \
+            --title "chore: update NPM dependencies" \
+            --body "Automated NPM dependency update" \
+            --head "${{ steps.branch.outputs.name }}" \
+            --base main