add badger

Author: Blargian

.github/workflows/badges-notify.yml

@@ -0,0 +1,57 @@
+name: Weekly Badge Monitor
+
+on:
+  schedule:
+    # Run every Monday at 10:00 AM Amsterdam time (UTC+1/+2)
+    # Using 8:00 UTC to account for Amsterdam time (adjusts for DST)
+    - cron: '0 8 * * 1'
+  workflow_dispatch: # Allow manual triggering
+
+jobs:
+  monitor-badges:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Make script executable
+        run: chmod +x .scripts/badger.sh
+
+      - name: Run badge finder script
+        id: find_badges
+        run: |
+          # Run the script and capture output
+          SCRIPT_OUTPUT=$(./scripts/badger.sh)
+          
+          # Escape the output for JSON and store in GitHub output
+          # Replace newlines with \n and escape quotes
+          ESCAPED_OUTPUT=$(echo "$SCRIPT_OUTPUT" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed ':a;N;$!ba;s/\n/\\n/g')
+          
+          echo "badges_output<<EOF" >> $GITHUB_OUTPUT
+          echo "$ESCAPED_OUTPUT" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Send webhook
+        env:
+          WEBHOOK_URL: ${{ secrets.DOCS_BADGER }}
+          BADGES_OUTPUT: ${{ steps.find_badges.outputs.badges_output }}
+        run: |
+          # Create JSON payload
+          JSON_PAYLOAD=$(cat <<EOF
+          {
+            "badges_list": "$BADGES_OUTPUT"
+          }
+          EOF
+          )
+          
+          # Send webhook
+          curl -X POST \
+            -H "Content-Type: application/json" \
+            -d "$JSON_PAYLOAD" \
+            "$WEBHOOK_URL"
+
+      - name: Log completion
+        run: |
+          echo "Badge monitoring completed successfully"
+          echo "Webhook sent to configured endpoint"

scripts/badger.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+
+# This script is used to generate a list of feature badges in use in the docs
+# It runs as part of a weekly github action and the result is sent as a notification
+# to the #docs channel in Slack.
+
+# Default to 'docs' directory if no argument provided
+DOCS_DIR="${1:-docs}"
+
+# Check if directory exists
+if [ ! -d "$DOCS_DIR" ]; then
+    echo "Error: Directory '$DOCS_DIR' does not exist"
+    exit 1
+fi
+
+# Components to search for
+components=(
+    "BetaBadge"
+    "ExperimentalBadge"
+    "PrivatePreviewBadge"
+    "CloudNotSupportedBadge"
+    "CloudAvailableBadge"
+)
+
+# Function to extract slug from a file's frontmatter
+extract_slug_from_file() {
+    local filepath="$1"
+    local slug=""
+
+    # Look for "slug: some/path/slug" in the file
+    slug=$(grep -m 1 "^slug:" "$filepath" 2>/dev/null | sed 's/^slug:[[:space:]]*//' | tr -d '"' | tr -d "'")
+
+    # If no slug found, return the filepath as fallback
+    if [ -z "$slug" ]; then
+        slug="[no slug] $filepath"
+    fi
+
+    echo "$slug"
+}
+
+# Search for each component and collect all slugs
+for component in "${components[@]}"; do
+    echo "$component:"
+
+    # Get unique files containing the component
+    files=$(grep -rl --include="*.md" --include="*.mdx" --include="*.jsx" --include="*.tsx" \
+        -E "<$component[[:space:]/>]|</$component>" "$DOCS_DIR" 2>/dev/null | sort -u)
+
+    if [ -z "$files" ]; then
+        echo "  (none)"
+    else
+        while IFS= read -r file; do
+            if [ -n "$file" ]; then
+                slug=$(extract_slug_from_file "$file")
+                if [[ "$slug" == \[no\ slug\]* ]]; then
+                    echo "  $slug"
+                else
+                    echo "  https://clickhouse.com/docs$slug"
+                fi
+            fi
+        done <<< "$files"
+    fi
+
+    echo
+done