Release Checklist

Release Checklist

Run this checklist before every public-facing release or production deployment.

1. Release Gate

npm run release:check

This runs all automated checks in sequence. It must pass cleanly before proceeding.

2. Visual Smoke Test

docker compose up -d --build md-tree
docker compose exec -T md-tree env CHROMIUM_BIN=/usr/bin/chromium node scripts/visual-smoke.js

3. i18n Validation

npm run i18n:validate

4. Production Audit

npm run audit:prod

5. Health Check (Local)

curl -fsS http://localhost:3210/health

6. Deploy to Production

bash deploy-prod.sh

Or manually:

# From /home/ga/md — build and push image
docker compose build

# In /home/ga/mdedit — recreate container
docker compose up -d --force-recreate

7. Health Check (Public)

curl -fsS https://md.2b6.de/health

8. Reference Smoke Test (Optional)

Run the reference document smoke test against the live public stage:

node scripts/reference-citations-smoke.js

Checklist Summary

• npm run release:check passes
• Visual smoke test passes
• npm run i18n:validate passes
• Local health check passes
• Deployed to production
• Public health check passes

See Also

• Deployment Stages
• Contributing
• Docker Setup