feat: pipeline to push the sample app's tutorials to the docs site

Author: darrenmelvison1

.github/scripts/aggregate-passport-metadata.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+// Configuration
+const PASSPORT_ROOT = './sample/Assets/Scripts/Passport';
+const OUTPUT_DIR = './_parsed';
+const OUTPUT_FILE = path.join(OUTPUT_DIR, 'passport-features.json');
+const FEATURES_JSON_PATH = path.join(PASSPORT_ROOT, 'features.json');
+
+// Ensure output directory exists
+if (!fs.existsSync(OUTPUT_DIR)) {
+  fs.mkdirSync(OUTPUT_DIR, { recursive: true });
+}
+
+console.log('Processing Passport features metadata...');
+
+// Load features.json to map script files to feature names
+let featuresMap = {};
+try {
+  const featuresContent = fs.readFileSync(FEATURES_JSON_PATH, 'utf8');
+  const featuresJson = JSON.parse(featuresContent);
+  
+  // Create mapping of script filename to feature name
+  featuresJson.features.forEach(feature => {
+    const [featureName, scriptFile] = Object.entries(feature)[0];
+    featuresMap[scriptFile] = featureName;
+  });
+} catch (error) {
+  console.error(`Error reading features.json: ${error.message}`);
+  process.exit(1);
+}
+
+// Find all metadata.json files
+const findMetadataFiles = () => {
+  const result = execSync(`find "${PASSPORT_ROOT}" -name "metadata.json" -type f`).toString().trim();
+  return result.split('\n').filter(Boolean);
+};
+
+// Process metadata files
+const processMetadataFiles = (metadataFiles) => {
+  const features = [];
+  
+  metadataFiles.forEach(metadataFile => {
+    console.log(`Processing ${metadataFile}`);
+    
+    // Extract feature directory
+    const featureDir = path.dirname(metadataFile);
+    
+    // Find script file in this directory
+    let featureName = '';
+    try {
+      const dirFiles = fs.readdirSync(featureDir);
+      const scriptFiles = dirFiles.filter(file => file.endsWith('.cs'));
+      
+      if (scriptFiles.length > 0) {
+        // Look up the feature name in featuresMap
+        const scriptFile = scriptFiles[0];
+        featureName = featuresMap[scriptFile] || '';
+      }
+      
+      // If not found in features.json, fallback to directory name
+      if (!featureName) {
+        console.warn(`Feature for script in ${featureDir} not found in features.json, using directory name`);
+        featureName = path.basename(featureDir);
+      }
+    } catch (error) {
+      console.warn(`Error processing directory ${featureDir}: ${error.message}`);
+      featureName = path.basename(featureDir);
+    }
+    
+    console.log(`Feature name: ${featureName}`);
+    
+    // Read and process metadata
+    try {
+      const metadataContent = fs.readFileSync(metadataFile, 'utf8');
+      const metadata = JSON.parse(metadataContent);
+      
+      // Add feature name to metadata
+      metadata.name = featureName;
+      features.push(metadata);
+    } catch (error) {
+      console.error(`Error processing metadata file ${metadataFile}: ${error.message}`);
+    }
+  });
+  
+  return features;
+};
+
+// Main execution
+const metadataFiles = findMetadataFiles();
+const features = processMetadataFiles(metadataFiles);
+
+// Create the final passport-features.json
+const passportFeatures = { features };
+fs.writeFileSync(OUTPUT_FILE, JSON.stringify(passportFeatures, null, 2));
+
+console.log(`Created ${OUTPUT_FILE}`); 

.github/scripts/process-passport-tutorials.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+set -e
+set -x
+
+# Directory where docs repo is cloned
+DOCS_REPO_DIR=${CLONE_DIR:-"./imx-docs"}
+
+# Root of the Passport features
+PASSPORT_ROOT="./sample/Assets/Scripts/Passport"
+
+echo "Processing Passport tutorials..."
+
+# Load features.json to map script files to feature names
+FEATURES_JSON="$PASSPORT_ROOT/features.json"
+if [ ! -f "$FEATURES_JSON" ]; then
+  echo "Error: features.json not found at $FEATURES_JSON"
+  exit 1
+fi
+
+# Create _tutorials directory in docs repo
+TUTORIALS_DIR="$DOCS_REPO_DIR/docs/main/example/zkEVM/passport-examples/_tutorials"
+mkdir -p "$TUTORIALS_DIR"
+
+# Find all tutorial.md files
+TUTORIAL_FILES=$(find "$PASSPORT_ROOT" -name "tutorial.md" -type f)
+
+for TUTORIAL_FILE in $TUTORIAL_FILES; do
+  echo "Processing $TUTORIAL_FILE"
+  
+  # Extract feature directory
+  FEATURE_DIR=$(dirname "$TUTORIAL_FILE")
+  
+  # Try to find script file in this directory
+  SCRIPT_FILE=$(find "$FEATURE_DIR" -name "*.cs" -type f | head -n 1)
+  if [ -z "$SCRIPT_FILE" ]; then
+    echo "Warning: No script file found in $FEATURE_DIR, using directory name"
+    FEATURE_NAME=$(basename "$FEATURE_DIR")
+  else
+    # Extract script filename
+    SCRIPT_FILENAME=$(basename "$SCRIPT_FILE")
+    
+    # Look up the feature name in features.json
+    FEATURE_NAME=$(jq -r ".features[] | to_entries[] | select(.value == \"$SCRIPT_FILENAME\") | .key" "$FEATURES_JSON")
+    
+    # If not found in features.json, fallback to directory name
+    if [ -z "$FEATURE_NAME" ] || [ "$FEATURE_NAME" == "null" ]; then
+      echo "Warning: Feature for script $SCRIPT_FILENAME not found in features.json, using directory name"
+      FEATURE_NAME=$(basename "$FEATURE_DIR")
+    fi
+  fi
+  
+  echo "Feature name: $FEATURE_NAME"
+  
+  # Copy and rename tutorial file
+  cp "$TUTORIAL_FILE" "$TUTORIALS_DIR/${FEATURE_NAME}.md"
+  echo "Copied $TUTORIAL_FILE to $TUTORIALS_DIR/${FEATURE_NAME}.md"
+done
+
+# Copy the generated JSON file
+JSON_FILE="./_parsed/passport-features.json"
+if [ -f "$JSON_FILE" ]; then
+  # Create directory for JSON file if it doesn't exist
+  JSON_DIR="$DOCS_REPO_DIR/docs/main/example/zkEVM/passport-examples"
+  mkdir -p "$JSON_DIR"
+  
+  # Copy JSON file
+  cp "$JSON_FILE" "$JSON_DIR/passport-features.json"
+  echo "Copied $JSON_FILE to $JSON_DIR/passport-features.json"
+else
+  echo "Warning: No passport-features.json found at $JSON_FILE"
+fi
+
+echo "Passport tutorial processing complete."