release(v1.7.2): harden asset stamping & CI verification

This commit is contained in:
Ryan
2025-10-29 16:54:22 -04:00
committed by GitHub
parent 55d5656139
commit 8cf5a34ae9
3 changed files with 58 additions and 21 deletions

View File

@@ -89,8 +89,16 @@ jobs:
run: | run: |
set -euo pipefail set -euo pipefail
ROOT="$(pwd)/staging" ROOT="$(pwd)/staging"
if grep -R -n "{{APP_QVER}}\|{{APP_VER}}" "$ROOT" --include='*.html' --include='*.php' --include='*.css' --include='*.js' 2>/dev/null; then if grep -R -n -E "{{APP_QVER}}|{{APP_VER}}" "$ROOT" \
echo "ERROR: Found unreplaced placeholders above in staging." --include='*.html' --include='*.php' --include='*.css' --include='*.js' 2>/dev/null; then
echo "---- DEBUG (show 10 hits with context) ----"
grep -R -n -E "{{APP_QVER}}|{{APP_VER}}" "$ROOT" \
--include='*.html' --include='*.php' --include='*.css' --include='*.js' \
| head -n 10 | while IFS=: read -r file line _; do
echo ">>> $file:$line"
nl -ba "$file" | sed -n "$((line-3)),$((line+3))p" || true
echo "----------------------------------------"
done
exit 1 exit 1
fi fi
echo "OK: No unreplaced placeholders in staging." echo "OK: No unreplaced placeholders in staging."

View File

@@ -1,6 +1,6 @@
# Changelog # Changelog
## Changes 10/29/2025 (v1.7.0 & v1.7.1) ## Changes 10/29/2025 (v1.7.0 & v1.7.1 & v1.7.2)
release(v1.7.0): asset cache-busting pipeline, public siteConfig cache, JS core split, and caching/security polish release(v1.7.0): asset cache-busting pipeline, public siteConfig cache, JS core split, and caching/security polish
@@ -70,6 +70,18 @@ release(v1.7.0): asset cache-busting pipeline, public siteConfig cache, JS core
- normalize line endings (strip CRLF) - normalize line endings (strip CRLF)
- stamp-assets.sh dont rely on the exec; invoke via bash - stamp-assets.sh dont rely on the exec; invoke via bash
release(v1.7.2): harden asset stamping & CI verification
### build(stamper)
- Rewrite scripts/stamp-assets.sh to be repo-agnostic and macOS/Windows friendly:
- Drop reliance on git ls-files/mapfile; use find + null-delimited loops
- Normalize CRLF to LF for all web assets before stamping
- Stamp ?v=<APP_QVER> in HTML/CSS/PHP and {{APP_VER}} everywhere
- Normalize any ".mjs|.js?v=..." occurrences inside JS (ESM imports/strings)
- Force-write public/js/version.js from VER (source of truth in stamped output)
- Print touched counts and fail fast if any {{APP_QVER}}|{{APP_VER}} remain
--- ---
## Changes 10/28/2025 (v1.6.11) ## Changes 10/28/2025 (v1.6.11)

View File

@@ -1,37 +1,54 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# usage: scripts/stamp-assets.sh v1.6.12 /path/to/target/dir # usage: scripts/stamp-assets.sh vX.Y.Z /path/to/target/dir
set -euo pipefail set -euo pipefail
VER="${1:?usage: stamp-assets.sh vX.Y.Z target_dir}" VER="${1:?usage: stamp-assets.sh vX.Y.Z target_dir}"
QVER="${VER#v}" QVER="${VER#v}"
TARGET="${2:-.}" TARGET="${2:-.}"
echo "Stamping assets in: $TARGET"
echo "VER=${VER} QVER=${QVER}"
cd "$TARGET" cd "$TARGET"
# Build file lists. Prefer git ls-files if we're in a repo, else use find. # Normalize CRLF to LF (if any files were edited on Windows)
if git rev-parse --is-inside-work-tree >/dev/null 2>&1; then # We only touch web assets.
mapfile -t HTML_CSS < <(git ls-files -- 'public/*.html' 'public/**/*.html' 'public/*.php' 'public/**/*.css' || true) find public \( -name '*.html' -o -name '*.php' -o -name '*.css' -o -name '*.js' \) -type f -print0 \
mapfile -t JSFILES < <(git ls-files -- 'public/*.js' 'public/**/*.js' 'js/*.js' 'js/**/*.js' || true) | xargs -0 -r sed -i 's/\r$//'
else
mapfile -t HTML_CSS < <(find public -type f \( -name '*.html' -o -name '*.php' -o -name '*.css' \) -print 2>/dev/null || true)
mapfile -t JSFILES < <(find public js -type f -name '*.js' -print 2>/dev/null || true)
fi
# HTML/CSS/PHP: stamp ?v=... and {{APP_VER}} # --- HTML/CSS/PHP: stamp ?v=... and {{APP_VER}} ---
for f in "${HTML_CSS[@]}"; do # (?v=...) -> ?v=<QVER>
HTML_CSS_COUNT=0
while IFS= read -r -d '' f; do
sed -E -i "s/(\?v=)[^\"'&<>\s]*/\1${QVER}/g" "$f" sed -E -i "s/(\?v=)[^\"'&<>\s]*/\1${QVER}/g" "$f"
sed -E -i "s/\{\{APP_VER\}\}/${VER}/g" "$f" sed -E -i "s/\{\{APP_VER\}\}/${VER}/g" "$f"
done HTML_CSS_COUNT=$((HTML_CSS_COUNT+1))
done < <(find public -type f \( -name '*.html' -o -name '*.php' -o -name '*.css' \) -print0)
# JS: stamp placeholders and normalize any pre-existing ?v=... # --- JS: stamp placeholders and normalize any pre-existing ?v=... ---
for f in "${JSFILES[@]}"; do JS_COUNT=0
while IFS= read -r -d '' f; do
# Replace placeholders
sed -E -i "s/\{\{APP_VER\}\}/${VER}/g" "$f" sed -E -i "s/\{\{APP_VER\}\}/${VER}/g" "$f"
sed -E -i "s/\{\{APP_QVER\}\}/${QVER}/g" "$f" sed -E -i "s/\{\{APP_QVER\}\}/${QVER}/g" "$f"
# Normalize any "?v=..." that appear in ESM imports or strings
# This keeps any ".js" or ".mjs" then forces ?v=<QVER>
perl -0777 -i -pe "s@(\.m?js)\?v=[^\"')]+@\1?v=${QVER}@g" "$f" perl -0777 -i -pe "s@(\.m?js)\?v=[^\"')]+@\1?v=${QVER}@g" "$f"
done JS_COUNT=$((JS_COUNT+1))
done < <(find public -type f -name '*.js' -print0)
# Optional: version.js fallback update # Force-write version.js (source of truth in stamped output)
if [[ -f public/js/version.js ]]; then if [[ -f public/js/version.js ]]; then
sed -E -i "s/(APP_VERSION\s*=\s*['\"])v[^'\"]+(['\"])/\1${VER}\2/" public/js/version.js printf "window.APP_VERSION = '%s';\n" "$VER" > public/js/version.js
fi fi
echo "Stamped assets in ${TARGET} to ${VER} (${QVER})" echo "Touched files: HTML/CSS/PHP=${HTML_CSS_COUNT}, JS=${JS_COUNT}"
# Final self-check: fail if anything is left
if grep -R -n -E "{{APP_QVER}}|{{APP_VER}}" public \
--include='*.html' --include='*.php' --include='*.css' --include='*.js' 2>/dev/null; then
echo "ERROR: Placeholders remain after stamping." >&2
exit 2
fi
echo "✅ Stamped to ${VER} (${QVER})"