@kabran-tecnologia/kabran-config 1.5.0 → 1.7.0

package/templates/.github/workflows/ci-quality.yml

@@ -0,0 +1,111 @@
+# Kabran CI Quality Workflow
+#
+# This workflow runs the Kabran CI pipeline and posts quality reports to PRs.
+#
+# Usage:
+#   Copy this file to your project's .github/workflows/ directory.
+#   Customize the ci-config.sh to define your project's CI steps.
+#
+# Requirements:
+#   - scripts/ci-config.sh with PROJECT_NAME, PM, and ci_steps() defined
+#   - @kabran-tecnologia/kabran-config installed as dev dependency
+
+name: CI Quality
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+# Cancel in-progress runs for the same branch
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    name: CI Pipeline
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pull-requests: write  # Required for PR comments
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Full history for baseline comparison
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run CI Pipeline
+        id: ci
+        env:
+          CI_USE_V2: 'true'
+          CI_OUTPUT_FILE_V2: 'docs/quality/ci-result.json'
+          # CI_SCOPE: 'all'  # Uncomment and set to filter by component
+        run: |
+          # Run CI using kabran-config runner
+          npx kabran-ci || exit_code=$?
+
+          # Ensure ci-result.json exists
+          if [ -f "docs/quality/ci-result.json" ]; then
+            echo "ci_result_exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "ci_result_exists=false" >> $GITHUB_OUTPUT
+          fi
+
+          exit ${exit_code:-0}
+
+      - name: Generate PR Comment
+        if: github.event_name == 'pull_request' && steps.ci.outputs.ci_result_exists == 'true'
+        id: comment
+        run: |
+          # Generate quality comparison comment
+          npx kabran-pr-comment \
+            --current docs/quality/ci-result.json \
+            --baseline-branch ${{ github.base_ref }} \
+            --output /tmp/pr-comment.md || true
+
+          if [ -f "/tmp/pr-comment.md" ]; then
+            echo "comment_exists=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Post PR Comment
+        if: github.event_name == 'pull_request' && steps.comment.outputs.comment_exists == 'true'
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: kabran-quality
+          path: /tmp/pr-comment.md
+
+      - name: Upload CI Result
+        if: always() && steps.ci.outputs.ci_result_exists == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: ci-result
+          path: docs/quality/ci-result.json
+          retention-days: 30
+
+      - name: Commit CI Result (main only)
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push' && steps.ci.outputs.ci_result_exists == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Only commit if there are changes
+          if git diff --quiet docs/quality/ci-result.json; then
+            echo "No changes to ci-result.json"
+          else
+            git add docs/quality/ci-result.json
+            git commit -m "chore(ci): update ci-result.json [skip ci]"
+            git push
+          fi

package/templates/telemetry/.env.telemetry.example

@@ -0,0 +1,118 @@
+# =============================================================================
+# Kabran Telemetry Configuration
+# =============================================================================
+# All variables are optional. Defaults are shown in comments.
+# Copy this file to your project and rename to .env or .env.local
+#
+# Documentation: https://github.com/kabran-owner/kabran-config#telemetry
+
+# =============================================================================
+# Core Configuration
+# =============================================================================
+
+# Enable/disable telemetry (default: true in production, false otherwise)
+# OTEL_ENABLED=true
+
+# Service name (REQUIRED for telemetry to work)
+# SERVICE_NAME=my-service
+
+# Service version (default: 1.0.0)
+# SERVICE_VERSION=1.0.0
+
+# Environment name (default: from NODE_ENV)
+# ENVIRONMENT=production
+
+# Service namespace for grouping (default: kabran)
+# OTEL_NAMESPACE=kabran
+# SERVICE_NAMESPACE=kabran
+
+# =============================================================================
+# OTLP Exporter Configuration
+# =============================================================================
+
+# OTLP collector endpoint (default: https://otel.kabran.com.br)
+# OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.kabran.com.br
+# OTEL_ENDPOINT=https://otel.kabran.com.br
+
+# Traces endpoint path (default: /v1/traces)
+# OTEL_EXPORTER_OTLP_TRACES_PATH=/v1/traces
+
+# Export timeout in milliseconds
+# Node.js (default: 10000)
+# OTEL_EXPORTER_OTLP_TIMEOUT=10000
+# Edge/Serverless (default: 5000)
+# OTEL_EXPORTER_OTLP_TIMEOUT_EDGE=5000
+
+# Sampling rate 0.0-1.0 (default: 0.1 = 10%)
+# OTEL_SAMPLE_RATE=0.1
+
+# =============================================================================
+# BatchSpanProcessor - Node.js
+# =============================================================================
+# Used for long-running processes (servers, workers)
+
+# Maximum spans in queue before dropping (default: 2048)
+# OTEL_BSP_MAX_QUEUE_SIZE=2048
+
+# Maximum spans per export batch (default: 512)
+# OTEL_BSP_MAX_EXPORT_BATCH_SIZE=512
+
+# Delay between exports in milliseconds (default: 5000)
+# OTEL_BSP_SCHEDULE_DELAY=5000
+
+# =============================================================================
+# BatchSpanProcessor - Frontend
+# =============================================================================
+# Optimized for browser environments (smaller batches, faster flush)
+
+# Maximum spans in queue (default: 100)
+# OTEL_BSP_MAX_QUEUE_SIZE_FRONTEND=100
+
+# Maximum spans per export batch (default: 10)
+# OTEL_BSP_MAX_EXPORT_BATCH_SIZE_FRONTEND=10
+
+# Delay between exports in milliseconds (default: 500)
+# OTEL_BSP_SCHEDULE_DELAY_FRONTEND=500
+
+# =============================================================================
+# Frontend Instrumentation
+# =============================================================================
+
+# CORS URLs for trace header propagation (comma-separated regex patterns)
+# Default: .*\.supabase\.co,.*\.kabran\.com\.br,localhost
+# OTEL_PROPAGATE_TRACE_HEADER_CORS_URLS=.*\.supabase\.co,.*\.kabran\.com\.br,localhost
+
+# User interaction events to trace (comma-separated)
+# Default: click,submit
+# OTEL_USER_INTERACTION_EVENTS=click,submit
+
+# =============================================================================
+# Middleware Configuration (Node.js)
+# =============================================================================
+
+# Paths to ignore in telemetry middleware (comma-separated)
+# Default: /health,/ready,/metrics
+# OTEL_IGNORE_PATHS=/health,/ready,/metrics
+
+# =============================================================================
+# Error Response Configuration (Edge)
+# =============================================================================
+
+# Error message for unhandled errors (default: Internal server error)
+# OTEL_ERROR_MESSAGE=Internal server error
+
+# Error code for unhandled errors (default: INTERNAL_ERROR)
+# OTEL_ERROR_CODE=INTERNAL_ERROR
+
+# =============================================================================
+# Logger Configuration
+# =============================================================================
+
+# Trace ID display length in logs (default: 8)
+# OTEL_LOG_TRACE_ID_LENGTH=8
+
+# Disable ANSI colors in logs (set to any value to disable)
+# NO_COLOR=1
+
+# Force enable/disable colors (overrides NO_COLOR)
+# FORCE_COLOR=true