climaybe 3.5.0 → 3.6.0

package/README.md

@@ -169,6 +169,7 @@ The CLI writes config into `climaybe.config.json`:
   "default_store": "voldt-staging.myshopify.com",
   "preview_workflows": true,
   "build_workflows": true,
+  "profile_workflows": true,
   "lighthouse_workflows": true,
   "commitlint": true,
   "cursor_skills": true,
@@ -263,6 +264,19 @@ Optional package, enabled via the `climaybe init` prompt (`Enable preview + clea
 | `reusable-cleanup-themes.yml` | workflow_call | `cleanup_mode: by_pr` deletes names ending with `-PR{padded}`; `orphan_pr` deletes `-PR<n>` when PR `n` is not open. Optional `result_artifact_prefix` for matrix fan-in on `pr-close` |
 | `reusable-extract-pr-number.yml` | workflow_call | Extracts padded/unpadded PR number outputs for naming and API-safe usage |
 
+### Optional Liquid performance profiling package
+
+Enabled via `climaybe init` prompt (`Enable Liquid performance profiling workflows?`; default: yes).
+
+Runs on every push to `main` (skipping store-sync and hotfix-backport commits). Creates a shared preview theme, measures TTFB for four core templates (index, collection, product, cart) over 4 iterations each, discards the first (warm-up) run, and reports the average of the last 3 in the GitHub Actions job summary.
+
+Requires `SHOPIFY_STORE_URL` and `SHOPIFY_THEME_ACCESS_TOKEN` secrets. When secrets are missing, the workflow skips gracefully.
+
+| Workflow | Trigger | What it does |
+|----------|---------|-------------|
+| `liquid-performance.yml` | Push to `main` | Gate check for secrets, then calls reusable profiler |
+| `reusable-liquid-profile.yml` | workflow_call | Shares theme, measures TTFB per template × 4 iterations, reports avg of last 3, cleans up theme |
+
 ### Build and Lighthouse workflows
 
 Optional package. `climaybe init` asks two separate questions: **build workflows** (bundle `_scripts` JS + compile Tailwind in CI; default: yes) and, if build is on, **Lighthouse CI** (performance + a11y budget on the `staging` branch; default: yes, stored as `lighthouse_workflows`). Lighthouse runs inside the build pipeline, so it requires build workflows.

package/bin/version.txt

@@ -1 +1 @@
-3.5.0
+3.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "climaybe",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Shopify CLI by Electric Maybe for theme CI/CD workflows, branch orchestration, app setup, and dev tooling",
   "type": "module",
   "bin": {

package/src/commands/init.js

@@ -5,6 +5,7 @@ import {
   promptStoreLoop,
   promptPreviewWorkflows,
   promptBuildWorkflows,
+  promptProfileWorkflows,
   promptLighthouseWorkflows,
   promptDevKit,
   promptVSCodeDevTasks,
@@ -99,6 +100,9 @@ async function runInitFlow() {
     enableLighthouseWorkflows = await promptLighthouseWorkflows();
   }
 
+  hint('CI that measures Liquid TTFB for core templates on every push to main.');
+  const enableProfileWorkflows = await promptProfileWorkflows();
+
   hint('Local config + ignore defaults for theme work (Theme Check, Prettier, Lighthouse, gitignore).', 'theme-dev-kit');
   const enableDevKit = await promptDevKit();
   let enableVSCodeTasks = false;
@@ -157,6 +161,7 @@ async function runInitFlow() {
     default_store: stores[0].domain,
     preview_workflows: enablePreviewWorkflows,
     build_workflows: enableBuildWorkflows,
+    profile_workflows: enableProfileWorkflows,
     lighthouse_workflows: enableBuildWorkflows ? enableLighthouseWorkflows : undefined,
     build_entrypoints_ready: enableBuildWorkflows ? missingBuildFiles?.length === 0 : undefined,
     dev_kit: enableDevKit,
@@ -213,6 +218,7 @@ async function runInitFlow() {
   scaffoldWorkflows(mode, {
     includePreview: enablePreviewWorkflows,
     includeBuild: enableBuildWorkflows,
+    includeProfile: enableProfileWorkflows,
   });
 
   // 7. Optional commitlint + Husky and the AI ruleset (rules, skills, agents + editor bridges)
@@ -259,6 +265,7 @@ async function runInitFlow() {
   }
   console.log(pc.dim(`  Preview workflows: ${enablePreviewWorkflows ? 'enabled' : 'disabled'}`));
   console.log(pc.dim(`  Build workflows: ${enableBuildWorkflows ? 'enabled' : 'disabled'}`));
+  console.log(pc.dim(`  Profile workflows: ${enableProfileWorkflows ? 'enabled' : 'disabled'}`));
   if (enableBuildWorkflows) {
     console.log(pc.dim(`  Lighthouse CI: ${enableLighthouseWorkflows ? 'enabled' : 'disabled'}`));
   }

package/src/commands/update-workflows.js

@@ -6,6 +6,7 @@ import {
   isCursorSkillsEnabled,
   getAiEditors,
   isPreviewWorkflowsEnabled,
+  isProfileWorkflowsEnabled,
   readConfig,
 } from '../lib/config.js';
 import { scaffoldWorkflows } from '../lib/workflows.js';
@@ -28,6 +29,7 @@ export async function updateCommand() {
   const mode = getMode();
   const includePreview = isPreviewWorkflowsEnabled();
   const includeBuild = isBuildWorkflowsEnabled();
+  const includeProfile = isProfileWorkflowsEnabled();
 
   // Keep theme project files in sync (root files, package.json, .gitignore, VS Code tasks).
   scaffoldThemeDevKit({
@@ -42,7 +44,7 @@ export async function updateCommand() {
     scaffoldAiConfig(process.cwd(), { editors: getAiEditors() });
   }
 
-  scaffoldWorkflows(mode, { includePreview, includeBuild });
+  scaffoldWorkflows(mode, { includePreview, includeBuild, includeProfile });
 
   console.log(pc.bold(pc.green('\n  Project files updated!\n')));
 }

package/src/lib/config.js

@@ -260,6 +260,14 @@ export function isCommitlintEnabled(cwd = process.cwd()) {
   return config?.commitlint === true;
 }
 
+/**
+ * Whether optional Liquid performance profile workflows are enabled.
+ */
+export function isProfileWorkflowsEnabled(cwd = process.cwd()) {
+  const config = readConfig(cwd);
+  return config?.profile_workflows === true;
+}
+
 /**
  * Whether the bundled AI ruleset (rules, skills, subagents) was installed (init or add-cursor).
  */

package/src/lib/prompts.js

@@ -149,6 +149,20 @@ export async function promptBuildWorkflows() {
   return !!enableBuildWorkflows;
 }
 
+/**
+ * Ask whether Liquid performance profile workflows should be scaffolded.
+ */
+export async function promptProfileWorkflows() {
+  const { enableProfileWorkflows } = await prompts({
+    type: 'confirm',
+    name: 'enableProfileWorkflows',
+    message: 'Enable Liquid performance profiling workflows? (TTFB measurement on main)',
+    initial: true,
+  });
+
+  return !!enableProfileWorkflows;
+}
+
 /**
  * Ask whether Lighthouse CI should run as part of the build pipeline.
  * Only meaningful when build workflows are enabled (Lighthouse runs after the build).

package/src/lib/workflows.js

@@ -37,7 +37,7 @@ function copyWorkflow(srcDir, fileName, destDir) {
  * but for simplicity we track known filenames instead.
  */
 function getKnownWorkflowFiles() {
-  const dirs = ['shared', 'single', 'multi', 'preview', 'build'];
+  const dirs = ['shared', 'single', 'multi', 'preview', 'build', 'profile'];
   const files = new Set();
   for (const dir of dirs) {
     const dirPath = join(TEMPLATES_DIR, dir);
@@ -72,7 +72,7 @@ function cleanWorkflows(cwd = process.cwd()) {
  * - Copies single/ or multi/ (+ single/) based on mode.
  */
 export function scaffoldWorkflows(mode = 'single', options = {}, cwd = process.cwd()) {
-  const { includePreview = false, includeBuild = false } = options;
+  const { includePreview = false, includeBuild = false, includeProfile = false } = options;
   const dest = ghWorkflowsDir(cwd);
   mkdirSync(dest, { recursive: true });
 
@@ -113,9 +113,17 @@ export function scaffoldWorkflows(mode = 'single', options = {}, cwd = process.c
     ensureBuildWorkflowDefaults(cwd);
   }
 
+  if (includeProfile) {
+    const profileDir = join(TEMPLATES_DIR, 'profile');
+    for (const f of listYmls(profileDir)) {
+      copyWorkflow(profileDir, f, dest);
+    }
+  }
+
   const total = readdirSync(dest).filter((f) => f.endsWith('.yml')).length;
   console.log(pc.green(`  Scaffolded ${total} workflow(s) → .github/workflows/`));
   console.log(pc.dim(`  Mode: ${mode}-store`));
   console.log(pc.dim(`  Preview workflows: ${includePreview ? 'enabled' : 'disabled'}`));
   console.log(pc.dim(`  Build workflows: ${includeBuild ? 'enabled' : 'disabled'}`));
+  console.log(pc.dim(`  Profile workflows: ${includeProfile ? 'enabled' : 'disabled'}`));
 }

package/src/workflows/profile/liquid-performance.yml

@@ -0,0 +1,47 @@
+# climaybe — Liquid Performance (Optional Profile Package)
+# Profiles Liquid rendering performance (TTFB) for core templates on main.
+# Pushes a shared theme, measures TTFB for index/collection/product/cart,
+# runs 4 iterations per template, reports the average of the last 3 runs.
+
+name: Liquid Performance
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  profile-gate:
+    runs-on: ubuntu-latest
+    if: >
+      !contains(github.event.head_commit.message, '[hotfix-backport]')
+      && !contains(github.event.head_commit.message, '[stores-to-root]')
+      && !contains(github.event.head_commit.message, '[root-to-stores]')
+    outputs:
+      run_profile: ${{ steps.check.outputs.run_profile }}
+    env:
+      SHOPIFY_STORE_URL: ${{ secrets.SHOPIFY_STORE_URL }}
+      SHOPIFY_THEME_ACCESS_TOKEN: ${{ secrets.SHOPIFY_THEME_ACCESS_TOKEN }}
+    steps:
+      - name: Check if profiling should run
+        id: check
+        run: |
+          SKIP_REASONS=()
+          if [ -z "$SHOPIFY_STORE_URL" ]; then
+            SKIP_REASONS+=("Missing secret: SHOPIFY_STORE_URL")
+          fi
+          if [ -z "$SHOPIFY_THEME_ACCESS_TOKEN" ]; then
+            SKIP_REASONS+=("Missing secret: SHOPIFY_THEME_ACCESS_TOKEN")
+          fi
+          if [ ${#SKIP_REASONS[@]} -gt 0 ]; then
+            echo "run_profile=false" >> $GITHUB_OUTPUT
+            echo "Liquid profiling skipped:"
+            for reason in "${SKIP_REASONS[@]}"; do echo "  - $reason"; done
+          else
+            echo "run_profile=true" >> $GITHUB_OUTPUT
+          fi
+
+  liquid-profile:
+    needs: [profile-gate]
+    if: needs.profile-gate.outputs.run_profile == 'true'
+    uses: ./.github/workflows/reusable-liquid-profile.yml
+    secrets: inherit

package/src/workflows/profile/reusable-liquid-profile.yml

@@ -0,0 +1,199 @@
+name: Reusable Liquid Profile
+
+on:
+  workflow_call:
+    inputs:
+      iterations:
+        required: false
+        type: number
+        default: 4
+        description: "Total profiling iterations per template (first is discarded as warm-up)"
+      store_alias_secret:
+        required: false
+        type: string
+        description: "Upper snake-case alias for scoped secret (e.g. VOLDT_STAGING). If set, uses SHOPIFY_*_<this>; else uses SHOPIFY_STORE_URL / SHOPIFY_THEME_ACCESS_TOKEN."
+
+jobs:
+  profile:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Validate theme root
+        run: |
+          if [ ! -f "layout/theme.liquid" ]; then
+            echo "layout/theme.liquid not found. Ensure workflow runs at theme repository root."
+            exit 1
+          fi
+
+      - name: Install Shopify CLI
+        run: npm install -g @shopify/cli @shopify/theme
+
+      - name: Share preview theme
+        id: share
+        env:
+          SHOPIFY_STORE_URL: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_STORE_URL_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_STORE_URL }}
+          SHOPIFY_THEME_ACCESS_TOKEN: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_THEME_ACCESS_TOKEN_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_THEME_ACCESS_TOKEN }}
+        run: |
+          if [ -z "$SHOPIFY_STORE_URL" ] || [ -z "$SHOPIFY_THEME_ACCESS_TOKEN" ]; then
+            echo "Missing Shopify secrets."
+            exit 1
+          fi
+
+          OUTPUT=$(shopify theme share \
+            --store "$SHOPIFY_STORE_URL" \
+            --password "$SHOPIFY_THEME_ACCESS_TOKEN" 2>&1)
+          STATUS=$?
+
+          echo "$OUTPUT"
+          if [ $STATUS -ne 0 ]; then
+            echo "Theme share failed."
+            exit $STATUS
+          fi
+
+          THEME_ID=$(echo "$OUTPUT" | sed -n 's/.*#\([0-9]*\).*/\1/p' | head -1)
+          if [ -z "$THEME_ID" ]; then
+            echo "Could not parse theme id from share output."
+            exit 1
+          fi
+
+          echo "theme_id=$THEME_ID" >> $GITHUB_OUTPUT
+          echo "Shared theme ID: $THEME_ID"
+
+      - name: Resolve profiling URLs
+        id: urls
+        run: |
+          URLS_JSON='[
+            {"template": "index",      "path": "/"},
+            {"template": "collection", "path": "/collections"},
+            {"template": "product",    "path": "/products"},
+            {"template": "cart",       "path": "/cart"}
+          ]'
+          echo "urls=$URLS_JSON" >> $GITHUB_OUTPUT
+
+      - name: Profile Liquid performance
+        id: profile
+        env:
+          SHOPIFY_STORE_URL: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_STORE_URL_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_STORE_URL }}
+          SHOPIFY_CLI_THEME_TOKEN: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_THEME_ACCESS_TOKEN_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_THEME_ACCESS_TOKEN }}
+          THEME_ID: ${{ steps.share.outputs.theme_id }}
+          ITERATIONS: ${{ inputs.iterations }}
+        run: |
+          STORE=$(echo "$SHOPIFY_STORE_URL" | sed 's|^https\?://||; s|/.*||')
+          REPORT_FILE="liquid-profile-report.md"
+          RESULTS_JSON="[]"
+
+          TEMPLATES=("index" "collection" "product" "cart")
+          PATHS=("/" "/collections" "/products" "/cart")
+
+          echo "## Liquid Performance Report" > "$REPORT_FILE"
+          echo "" >> "$REPORT_FILE"
+          echo "| Template | Avg TTFB (last 3) | Run 1 (warm-up) | Run 2 | Run 3 | Run 4 |" >> "$REPORT_FILE"
+          echo "|----------|-------------------|-----------------|-------|-------|-------|" >> "$REPORT_FILE"
+
+          HAS_ERROR=false
+
+          for i in "${!TEMPLATES[@]}"; do
+            TEMPLATE="${TEMPLATES[$i]}"
+            URL_PATH="${PATHS[$i]}"
+            echo ""
+            echo "=== Profiling $TEMPLATE ($URL_PATH) ==="
+
+            TIMES=()
+            ALL_TIMES_DISPLAY=()
+
+            for ((iter=1; iter<=ITERATIONS; iter++)); do
+              echo "  Iteration $iter/$ITERATIONS for $TEMPLATE..."
+
+              START_MS=$(date +%s%N)
+              HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" \
+                --connect-timeout 30 \
+                --max-time 60 \
+                "https://${STORE}${URL_PATH}?preview_theme_id=${THEME_ID}" \
+                -H "Accept: text/html") || true
+              END_MS=$(date +%s%N)
+
+              TTFB_MS=$(( (END_MS - START_MS) / 1000000 ))
+              echo "    HTTP $HTTP_CODE — TTFB: ${TTFB_MS}ms"
+
+              TIMES+=("$TTFB_MS")
+              ALL_TIMES_DISPLAY+=("${TTFB_MS}ms")
+
+              if [ "$HTTP_CODE" != "200" ] && [ "$HTTP_CODE" != "301" ] && [ "$HTTP_CODE" != "302" ]; then
+                echo "    Warning: unexpected HTTP status $HTTP_CODE"
+              fi
+
+              sleep 2
+            done
+
+            WARMUP="${ALL_TIMES_DISPLAY[0]}"
+
+            if [ ${#TIMES[@]} -ge 4 ]; then
+              SUM=0
+              COUNT=0
+              for ((j=1; j<${#TIMES[@]}; j++)); do
+                SUM=$((SUM + TIMES[j]))
+                COUNT=$((COUNT + 1))
+              done
+              AVG=$((SUM / COUNT))
+            else
+              SUM=0
+              for t in "${TIMES[@]}"; do
+                SUM=$((SUM + t))
+              done
+              AVG=$((SUM / ${#TIMES[@]}))
+            fi
+
+            RUN2="${ALL_TIMES_DISPLAY[1]:-n/a}"
+            RUN3="${ALL_TIMES_DISPLAY[2]:-n/a}"
+            RUN4="${ALL_TIMES_DISPLAY[3]:-n/a}"
+
+            echo "| \`$TEMPLATE\` | **${AVG}ms** | $WARMUP | $RUN2 | $RUN3 | $RUN4 |" >> "$REPORT_FILE"
+
+            RESULTS_JSON=$(echo "$RESULTS_JSON" | jq --arg t "$TEMPLATE" --argjson avg "$AVG" \
+              --argjson times "$(printf '%s\n' "${TIMES[@]}" | jq -s '.')" \
+              '. + [{"template": $t, "avg_ms": $avg, "times_ms": $times}]')
+
+            echo "  → $TEMPLATE average (last 3): ${AVG}ms"
+          done
+
+          echo "" >> "$REPORT_FILE"
+          echo "_${ITERATIONS} iterations per template; average excludes the first (warm-up) run._" >> "$REPORT_FILE"
+          echo "_Theme ID: ${THEME_ID} | Store: ${STORE}_" >> "$REPORT_FILE"
+
+          echo ""
+          echo "=== Report ==="
+          cat "$REPORT_FILE"
+
+          {
+            echo "report<<REPORT_EOF"
+            cat "$REPORT_FILE"
+            echo "REPORT_EOF"
+          } >> $GITHUB_OUTPUT
+
+          echo "results_json=$(echo "$RESULTS_JSON" | jq -c '.')" >> $GITHUB_OUTPUT
+
+      - name: Post results as job summary
+        env:
+          REPORT: ${{ steps.profile.outputs.report }}
+        run: |
+          echo "$REPORT" >> $GITHUB_STEP_SUMMARY
+
+      - name: Cleanup preview theme
+        if: always()
+        env:
+          SHOPIFY_STORE_URL: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_STORE_URL_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_STORE_URL }}
+          SHOPIFY_THEME_ACCESS_TOKEN: ${{ inputs.store_alias_secret && secrets[format('SHOPIFY_THEME_ACCESS_TOKEN_{0}', inputs.store_alias_secret)] || secrets.SHOPIFY_THEME_ACCESS_TOKEN }}
+          THEME_ID: ${{ steps.share.outputs.theme_id }}
+        run: |
+          if [ -z "$THEME_ID" ]; then
+            echo "No theme ID to clean up."
+            exit 0
+          fi
+
+          echo "Deleting preview theme $THEME_ID..."
+          shopify theme delete --theme "$THEME_ID" \
+            --store "$SHOPIFY_STORE_URL" \
+            --password "$SHOPIFY_THEME_ACCESS_TOKEN" \
+            --force 2>&1 || echo "Theme cleanup failed (non-fatal)."