Files
gh-christianlouis-docuelevate/scripts/generate_build_metadata.sh
copilot-swe-agent[bot] d18c10996a feat(release): add named release anchors with codenames and roadmap integration
- Add release_names.json mapping version ranges to codenames
- Add release_name property to Settings in app/config.py
- Update build metadata script to include codename in RUNTIME_INFO
- Display release codename in status dashboard and page footer
- Inject release_name globally via template response wrapper
- Update ROADMAP.md with codenames for all milestone releases
- Add docs/ReleaseNaming.md with naming guide and best practices
- Add comprehensive tests for release name resolution

Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
2026-03-01 18:32:46 +00:00

129 lines
3.6 KiB
Bash
Executable File

#!/bin/bash
#
# Generate build metadata files for DocuElevate
#
# This script generates metadata files that are read by the application
# at runtime to display version, build date, and Git commit information
# in the /status endpoint.
#
# Files generated:
# - BUILD_DATE: UTC timestamp of when the build was created
# - GIT_SHA: Short Git commit SHA (7 characters)
# - RUNTIME_INFO: Combined build information
#
# Usage:
# ./scripts/generate_build_metadata.sh
#
# The script should be run during Docker build or CI/CD pipeline.
set -e
# Get the directory where this script is located
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)"
# Navigate to project root
cd "${PROJECT_ROOT}"
echo "Generating build metadata..."
# Generate BUILD_DATE in ISO 8601 format with time (UTC)
BUILD_DATE=$(date -u '+%Y-%m-%dT%H:%M:%SZ')
echo "${BUILD_DATE}" > BUILD_DATE
echo "✓ BUILD_DATE: ${BUILD_DATE}"
# Generate GIT_SHA (short commit hash)
if git rev-parse --git-dir > /dev/null 2>&1; then
GIT_SHA=$(git rev-parse --short=7 HEAD)
echo "${GIT_SHA}" > GIT_SHA
echo "✓ GIT_SHA: ${GIT_SHA}"
# Get full commit SHA for reference
GIT_FULL_SHA=$(git rev-parse HEAD)
# Get commit date
GIT_COMMIT_DATE=$(git log -1 --format=%cd --date=iso-strict)
# Get branch name (if available)
GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown")
else
echo "⚠ Warning: Not a git repository, using 'unknown' for Git metadata"
echo "unknown" > GIT_SHA
GIT_SHA="unknown"
GIT_FULL_SHA="unknown"
GIT_COMMIT_DATE="unknown"
GIT_BRANCH="unknown"
fi
# Update VERSION file: prefer PSR's NEW_VERSION env var, then existing file
if [ -n "${NEW_VERSION}" ]; then
echo "${NEW_VERSION}" > VERSION
VERSION="${NEW_VERSION}"
echo "✓ VERSION (from NEW_VERSION env): ${VERSION}"
elif [ -f "VERSION" ]; then
VERSION=$(cat VERSION | tr -d '\n')
echo "✓ VERSION (from file): ${VERSION}"
else
echo "⚠ Warning: VERSION file not found and NEW_VERSION not set"
VERSION="unknown"
fi
# Look up release codename from release_names.json
RELEASE_NAME=""
if [ -f "release_names.json" ] && command -v python3 > /dev/null 2>&1; then
MINOR_PREFIX=$(echo "${VERSION}" | cut -d. -f1-2)
RELEASE_NAME=$(python3 -c "
import json, sys
try:
with open('release_names.json') as f:
data = json.load(f)
releases = data.get('releases', {})
version = '${VERSION}'
minor = '${MINOR_PREFIX}'
codename = None
if version in releases:
codename = releases[version].get('codename')
elif minor in releases:
codename = releases[minor].get('codename')
if codename:
print(codename)
except Exception:
pass
" 2>/dev/null || true)
fi
if [ -n "${RELEASE_NAME}" ]; then
echo "✓ Release Name: ${RELEASE_NAME}"
fi
# Generate RUNTIME_INFO with combined metadata
RUNTIME_INFO_CONTENT="DocuElevate Build Information
==============================
Version: ${VERSION}
Build Date: ${BUILD_DATE}
Git Commit: ${GIT_FULL_SHA}
Git Short SHA: ${GIT_SHA}
Git Branch: ${GIT_BRANCH}
Commit Date: ${GIT_COMMIT_DATE}"
if [ -n "${RELEASE_NAME}" ]; then
RUNTIME_INFO_CONTENT="${RUNTIME_INFO_CONTENT}
Release Name: ${RELEASE_NAME}"
fi
RUNTIME_INFO_CONTENT="${RUNTIME_INFO_CONTENT}
Build Timestamp: $(date -u '+%Y-%m-%dT%H:%M:%SZ')
=============================="
echo "${RUNTIME_INFO_CONTENT}" > RUNTIME_INFO
echo "✓ RUNTIME_INFO generated"
echo ""
echo "Build metadata generation complete!"
echo ""
echo "Files created/updated:"
echo " - BUILD_DATE"
echo " - GIT_SHA"
echo " - RUNTIME_INFO"
echo ""