b5eea8d30c
Add visible "Last Update" badge in README to showcase guide's high
activity (95+ releases in 33 days). Auto-updates via sync-version.sh.
Changes:
- README.md: Badge "Updated-{date}_·_v{version}" before Quiz badge
- README.md: Footer now shows "Updated daily · {date}"
- sync-version.sh: Auto-update date in badge + footer on version sync
Badge links to CHANGELOG.md for full history.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
121 lines
3.2 KiB
Bash
Executable file
121 lines
3.2 KiB
Bash
Executable file
#!/bin/bash
|
|
# sync-version.sh - Sync version from VERSION file to all documentation
|
|
# Usage: ./scripts/sync-version.sh [--check]
|
|
# --check : Only check, don't modify (exit 1 if mismatch)
|
|
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
|
cd "$REPO_ROOT"
|
|
|
|
# Read source of truth
|
|
if [[ ! -f VERSION ]]; then
|
|
echo "❌ VERSION file not found"
|
|
exit 1
|
|
fi
|
|
|
|
VERSION=$(cat VERSION | tr -d '[:space:]')
|
|
CHECK_ONLY=false
|
|
ERRORS=0
|
|
|
|
if [[ "${1:-}" == "--check" ]]; then
|
|
CHECK_ONLY=true
|
|
fi
|
|
|
|
echo "=== Version Sync ==="
|
|
echo "Source: VERSION → $VERSION"
|
|
echo ""
|
|
|
|
# Function to check/update a file
|
|
check_file() {
|
|
local file="$1"
|
|
|
|
if [[ ! -f "$file" ]]; then
|
|
echo "⚠️ $file not found"
|
|
return
|
|
fi
|
|
|
|
# Find version numbers in file (3.x.x pattern only)
|
|
local old_versions=$(grep -oE '3\.[0-9]+\.[0-9]+' "$file" 2>/dev/null | sort -u | grep -v "^${VERSION}$" || true)
|
|
|
|
if [[ -n "$old_versions" ]]; then
|
|
echo "📍 $file: found outdated versions"
|
|
for v in $old_versions; do
|
|
echo " - $v → $VERSION"
|
|
done
|
|
|
|
if $CHECK_ONLY; then
|
|
ERRORS=$((ERRORS + 1))
|
|
else
|
|
# Replace all old 3.x.x versions with current version
|
|
for v in $old_versions; do
|
|
# Escape dots for sed regex (prevents matching digits in URLs/IDs)
|
|
local escaped_v=$(echo "$v" | sed 's/\./\\./g')
|
|
# macOS compatible sed
|
|
sed -i '' "s/$escaped_v/$VERSION/g" "$file"
|
|
done
|
|
echo "✅ $file: updated"
|
|
fi
|
|
else
|
|
# Check if file contains current version
|
|
if grep -q "$VERSION" "$file" 2>/dev/null; then
|
|
echo "✅ $file: OK ($VERSION)"
|
|
else
|
|
echo "⚠️ $file: no version found"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# Function to update date in README
|
|
update_readme_date() {
|
|
local file="README.md"
|
|
|
|
if [[ ! -f "$file" ]]; then
|
|
echo "⚠️ $file not found"
|
|
return
|
|
fi
|
|
|
|
# Get current date in format: Feb 10, 2026
|
|
local current_date=$(date +"%b %-d, %Y")
|
|
# Format for badge: Feb_10,_2026
|
|
local badge_date=$(echo "$current_date" | sed 's/ /_/g')
|
|
|
|
if $CHECK_ONLY; then
|
|
# In check mode, verify if dates need updating
|
|
if ! grep -q "Updated-${badge_date}_·_v${VERSION}-brightgreen" "$file" 2>/dev/null; then
|
|
echo "📍 $file: date badge needs update (→ $current_date)"
|
|
ERRORS=$((ERRORS + 1))
|
|
fi
|
|
if ! grep -q "Updated daily · ${current_date}" "$file" 2>/dev/null; then
|
|
echo "📍 $file: footer date needs update (→ $current_date)"
|
|
ERRORS=$((ERRORS + 1))
|
|
fi
|
|
else
|
|
# Update badge date pattern: Updated-XXX-brightgreen
|
|
sed -i '' "s|Updated-[^-]*-brightgreen|Updated-${badge_date}_·_v${VERSION}-brightgreen|g" "$file"
|
|
|
|
# Update footer date pattern: Updated daily · DATE (preserve space before |)
|
|
sed -i '' "s|Updated daily · [^|]*|Updated daily · ${current_date} |g" "$file"
|
|
|
|
echo "✅ $file: date updated (→ $current_date)"
|
|
fi
|
|
}
|
|
|
|
# Check main files
|
|
check_file "README.md"
|
|
check_file "guide/cheatsheet.md"
|
|
check_file "guide/ultimate-guide.md"
|
|
check_file "machine-readable/reference.yaml"
|
|
|
|
# Update README date (version and date in badge + footer)
|
|
update_readme_date
|
|
|
|
echo ""
|
|
|
|
if $CHECK_ONLY && [[ $ERRORS -gt 0 ]]; then
|
|
echo "❌ $ERRORS file(s) need version update"
|
|
echo "Run: ./scripts/sync-version.sh"
|
|
exit 1
|
|
fi
|
|
|
|
echo "✅ Done"
|