Add Git commit ID tracking to health endpoint
Features:
- Health endpoint now returns git_commit SHA and version
- Auto-detects git commit during Docker build
- Falls back to 'unknown' if git info unavailable
- Allows AI agents to verify deployed version
Changes:
1. server.js: Add git_commit and version to /health response
2. Dockerfile: Add git installation and commit detection
3. Dockerfile: Accept GIT_COMMIT and APP_VERSION build args
4. docker-compose.yml: Pass build args and env vars for versioning
5. README.md: Document version tracking in health endpoint
Example response:
{
"status": "healthy",
"postgres": "connected",
"redis": "connected",
"timestamp": "2026-02-14T10:30:00.000Z",
"git_commit": "eb6b6e0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q",
"version": "1.0.0"
}
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
7
.saac/config.json
Normal file
7
.saac/config.json
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"applicationUuid": "j4ggogg8o4cs44s0ocks48o8",
|
||||||
|
"applicationName": "application",
|
||||||
|
"subdomain": "template-001",
|
||||||
|
"domainSuffix": "startanaicompany.com",
|
||||||
|
"gitRepository": "git@git.startanaicompany.com:StartAnAiCompanyTemplates/template_001.git"
|
||||||
|
}
|
||||||
18
Dockerfile
18
Dockerfile
@@ -1,9 +1,13 @@
|
|||||||
FROM node:18-alpine
|
FROM node:18-alpine
|
||||||
|
|
||||||
|
# Build arguments for versioning
|
||||||
|
ARG GIT_COMMIT=unknown
|
||||||
|
ARG APP_VERSION=1.0.0
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# Install curl for healthcheck
|
# Install curl for healthcheck and git for commit info
|
||||||
RUN apk add --no-cache curl
|
RUN apk add --no-cache curl git
|
||||||
|
|
||||||
# Copy package files first for layer caching
|
# Copy package files first for layer caching
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
@@ -12,6 +16,16 @@ RUN npm install --production
|
|||||||
# Copy app code (changes more often — below the cached layer)
|
# Copy app code (changes more often — below the cached layer)
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
|
# Try to get git commit if not provided and .git exists
|
||||||
|
RUN if [ "$GIT_COMMIT" = "unknown" ] && [ -d .git ]; then \
|
||||||
|
GIT_COMMIT=$(git rev-parse HEAD 2>/dev/null || echo "unknown"); \
|
||||||
|
fi && \
|
||||||
|
echo "export GIT_COMMIT=${GIT_COMMIT}" >> /etc/profile.d/git-version.sh
|
||||||
|
|
||||||
|
# Set environment variables for runtime
|
||||||
|
ENV GIT_COMMIT=${GIT_COMMIT} \
|
||||||
|
APP_VERSION=${APP_VERSION}
|
||||||
|
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
HEALTHCHECK --interval=10s --timeout=3s --start-period=5s --retries=2 \
|
HEALTHCHECK --interval=10s --timeout=3s --start-period=5s --retries=2 \
|
||||||
|
|||||||
30
README.md
30
README.md
@@ -275,13 +275,25 @@ saac deployments
|
|||||||
### Step 7: Verify Deployment
|
### Step 7: Verify Deployment
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check health endpoint
|
# Check health endpoint (includes git commit ID)
|
||||||
curl https://template-001.startanaicompany.com/health
|
curl https://template-001.startanaicompany.com/health
|
||||||
|
|
||||||
|
# You should see a response like:
|
||||||
|
# {
|
||||||
|
# "status": "healthy",
|
||||||
|
# "postgres": "connected",
|
||||||
|
# "redis": "connected",
|
||||||
|
# "timestamp": "2026-02-14T10:30:00.000Z",
|
||||||
|
# "git_commit": "eb6b6e0...",
|
||||||
|
# "version": "1.0.0"
|
||||||
|
# }
|
||||||
|
|
||||||
# View the website
|
# View the website
|
||||||
curl https://template-001.startanaicompany.com
|
curl https://template-001.startanaicompany.com
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note:** The `git_commit` field in the health endpoint shows which version is deployed, making it easy for AI agents to track deployments.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
@@ -395,7 +407,7 @@ Returns the main template website with information about the deployment.
|
|||||||
|
|
||||||
### GET /health
|
### GET /health
|
||||||
|
|
||||||
Health check endpoint that verifies connections to PostgreSQL and Redis.
|
Health check endpoint that verifies connections to PostgreSQL and Redis, and returns deployment version information.
|
||||||
|
|
||||||
**Response:**
|
**Response:**
|
||||||
```json
|
```json
|
||||||
@@ -403,7 +415,9 @@ Health check endpoint that verifies connections to PostgreSQL and Redis.
|
|||||||
"status": "healthy",
|
"status": "healthy",
|
||||||
"postgres": "connected",
|
"postgres": "connected",
|
||||||
"redis": "connected",
|
"redis": "connected",
|
||||||
"timestamp": "2026-02-14T10:30:00.000Z"
|
"timestamp": "2026-02-14T10:30:00.000Z",
|
||||||
|
"git_commit": "eb6b6e0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q",
|
||||||
|
"version": "1.0.0"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -411,10 +425,18 @@ Health check endpoint that verifies connections to PostgreSQL and Redis.
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"status": "unhealthy",
|
"status": "unhealthy",
|
||||||
"error": "Connection error message"
|
"error": "Connection error message",
|
||||||
|
"git_commit": "eb6b6e0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q",
|
||||||
|
"version": "1.0.0"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Version Tracking:**
|
||||||
|
- `git_commit`: The Git commit SHA of the deployed code (auto-detected during build)
|
||||||
|
- `version`: Application version (defaults to 1.0.0, can be set via APP_VERSION env var)
|
||||||
|
|
||||||
|
This allows AI agents and monitoring tools to verify which version is currently running.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|||||||
@@ -2,7 +2,11 @@ version: '3.8'
|
|||||||
|
|
||||||
services:
|
services:
|
||||||
app:
|
app:
|
||||||
build: .
|
build:
|
||||||
|
context: .
|
||||||
|
args:
|
||||||
|
GIT_COMMIT: ${GIT_COMMIT:-unknown}
|
||||||
|
APP_VERSION: ${APP_VERSION:-1.0.0}
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
environment:
|
environment:
|
||||||
- NODE_ENV=production
|
- NODE_ENV=production
|
||||||
@@ -14,6 +18,8 @@ services:
|
|||||||
- POSTGRES_DB=template_db
|
- POSTGRES_DB=template_db
|
||||||
- REDIS_HOST=redis
|
- REDIS_HOST=redis
|
||||||
- REDIS_PORT=6379
|
- REDIS_PORT=6379
|
||||||
|
- GIT_COMMIT=${GIT_COMMIT:-unknown}
|
||||||
|
- APP_VERSION=${APP_VERSION:-1.0.0}
|
||||||
depends_on:
|
depends_on:
|
||||||
postgres:
|
postgres:
|
||||||
condition: service_healthy
|
condition: service_healthy
|
||||||
|
|||||||
@@ -55,12 +55,16 @@ app.get('/health', async (req, res) => {
|
|||||||
status: 'healthy',
|
status: 'healthy',
|
||||||
postgres: 'connected',
|
postgres: 'connected',
|
||||||
redis: 'connected',
|
redis: 'connected',
|
||||||
timestamp: pgResult.rows[0].now
|
timestamp: pgResult.rows[0].now,
|
||||||
|
git_commit: process.env.GIT_COMMIT || 'unknown',
|
||||||
|
version: process.env.APP_VERSION || '1.0.0'
|
||||||
});
|
});
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
res.status(500).json({
|
res.status(500).json({
|
||||||
status: 'unhealthy',
|
status: 'unhealthy',
|
||||||
error: error.message
|
error: error.message,
|
||||||
|
git_commit: process.env.GIT_COMMIT || 'unknown',
|
||||||
|
version: process.env.APP_VERSION || '1.0.0'
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user