Update 0.7.2

Author: jamesgober

.github/workflows/perf.yml

@@ -1,19 +1,23 @@
 name: Perf
 
 on:
-  schedule:
-    # Sunday 02:00 UTC
-    - cron: "0 2 * * 0"
-    # Wednesday 02:00 UTC
-    - cron: "0 2 * * 3"
+  # Manual trigger only by default; set ENABLE_PERF to true to enable scheduled runs
   workflow_dispatch: {}
+  schedule:
+    # Disabled by default via job-level gate; enable by setting ENABLE_PERF to 'true'
+    - cron: "0 2 * * 0" # Sunday 02:00 UTC
+    - cron: "0 2 * * 3" # Wednesday 02:00 UTC
+
+env:
+  # Gate to disable perf by default in CI. Set to 'true' to enable.
+  ENABLE_PERF: "false"
 
 jobs:
   perf-tests:
     name: Perf Tests and Benches
     runs-on: ubuntu-latest
-    # Only run on main branch for scheduled/manual invocations
-    if: github.ref_name == 'main'
+    # Only run when explicitly enabled and on main branch for scheduled/manual invocations
+    if: ${{ env.ENABLE_PERF == 'true' && github.ref_name == 'main' }}
     concurrency:
       group: perf-${{ github.ref }}
       cancel-in-progress: false
@@ -64,6 +68,8 @@ jobs:
           find target/criterion -maxdepth 2 -type d -print || true
 
       - name: Compare Criterion results to baselines (watch_timer_hot)
+        env:
+          PERF_COMPARE_STRICT: "0"
         run: |
           if [ ! -d target/criterion ]; then
             echo "No Criterion results found; skipping watch_timer_hot baseline comparison.";
@@ -85,6 +91,8 @@ jobs:
             --save-baseline current
 
       - name: Compare Criterion results to baselines (timers)
+        env:
+          PERF_COMPARE_STRICT: "0"
         run: |
           if [ ! -d target/criterion ]; then
             echo "No Criterion results found; skipping timers baseline comparison.";
@@ -106,6 +114,8 @@ jobs:
             --save-baseline current
 
       - name: Compare Criterion results to baselines (histogram_hot)
+        env:
+          PERF_COMPARE_STRICT: "0"
         run: |
           if [ ! -d target/criterion ]; then
             echo "No Criterion results found; skipping histogram_hot baseline comparison.";

CHANGELOG.md

@@ -19,6 +19,8 @@
 - Bench workflow `.github/workflows/bench.yml`: use `examples/zero_overhead.rs` for the no-default-features run, and keep `overhead_compare` for the enabled run to avoid feature gating conflicts.
 - Module order clean-up in `src/lib.rs` to satisfy Code Quality check (place `mod trace;` after `mod timer;`).
 - Documentation consistency sweep: ensure install snippets reference `0.7.1` across `docs/` feature pages and API.
+- Perf workflow `.github/workflows/perf.yml`: gated behind `ENABLE_PERF` (default `false`) so perf does not run by default in CI; comparison steps include pre-checks and run in lenient mode by default.
+- Baseline comparator `scripts/compare_criterion_baseline.sh`: made non-fatal when Criterion output is absent or no baseline keys match; add `PERF_COMPARE_STRICT=1` to enforce strict behavior. Defaults to lenient; workflow passes `PERF_COMPARE_STRICT=0`.
 
 
 <br>

scripts/compare_criterion_baseline.sh

@@ -32,22 +32,32 @@ if [[ -d "target/criterion/${GROUP_NAME}" ]]; then
 elif [[ -d "target/criterion" ]]; then
   BASE_DIR="target/criterion"
 else
-  echo "error: criterion directory not found: target/criterion" >&2
-  exit 2
+  echo "note: criterion directory not found: target/criterion — skipping baseline comparison" >&2
+  echo "Baseline comparison skipped."
+  exit 0
 fi
 
 # Optional: show which layout is used (useful in CI logs)
 echo "Using Criterion base directory: ${BASE_DIR}" >&2
 
 fail_count=0
+found_count=0
+total_count=0
+missing_count=0
 
 # Iterate baseline entries: key, median_s, tolerance
 while IFS=$'\t' read -r KEY MEDIAN_S TOL; do
   # Build path to criterion estimates for this key
+  total_count=$((total_count + 1))
+
   EST_PATH="${BASE_DIR}/${KEY}/new/estimates.json"
   if [[ ! -f "${EST_PATH}" ]]; then
     echo "missing estimates: ${EST_PATH}" >&2
-    fail_count=$((fail_count + 1))
+    missing_count=$((missing_count + 1))
+    # Only fail on missing when strict mode is enabled
+    if [[ "${PERF_COMPARE_STRICT:-}" == "1" ]]; then
+      fail_count=$((fail_count + 1))
+    fi
     continue
   fi
 
@@ -81,6 +91,8 @@ PY
   BASE_P=$(pretty "${MEDIAN_S}")
   ALWD_P=$(pretty "${ALLOWED}")
 
+  found_count=$((found_count + 1))
+
   if [[ "${OK}" == "1" ]]; then
     echo "OK   ${KEY} actual=${ACT_P} baseline=${BASE_P} tol=${TOL} allowed<=${ALWD_P}"
   else
@@ -90,8 +102,14 @@ PY
 
 done < <(jq -r 'to_entries[] | [ .key, .value.median_s, .value.tolerance ] | @tsv' "${BASELINE_JSON}")
 
+if [[ ${found_count} -eq 0 ]]; then
+  echo "note: no matching Criterion results were found for any baseline keys (total=${total_count}, missing=${missing_count})." >&2
+  echo "Baseline comparison skipped."
+  exit 0
+fi
+
 if [[ ${fail_count} -gt 0 ]]; then
-  echo "Baseline comparison failed: ${fail_count} regression(s) detected." >&2
+  echo "Baseline comparison failed: ${fail_count} regression(s) detected. (checked=${found_count}, missing=${missing_count}, total=${total_count})" >&2
   exit 1
 fi