Upgrade Checklist
Step-by-step checklist for upgrading Ever Gauzy versions.
Pre-Upgradeโ
- Read release notes โ Check changelog for breaking changes
- Backup database โ Full pg_dump before any upgrade
- Test on staging โ Never upgrade production first
- Check Node.js version โ Verify compatible Node.js version
- Review migration files โ Check for new database migrations
- Review env changes โ Check for new/renamed environment variables
- Notify team โ Announce maintenance window
During Upgradeโ
1. Pull Latest Codeโ
git fetch origin
git checkout v1.X.X # or latest tag
2. Install Dependenciesโ
yarn install --frozen-lockfile
3. Run Migrationsโ
# TypeORM
yarn typeorm migration:run
# MikroORM
npx mikro-orm migration:up
4. Buildโ
yarn build:api
yarn build
5. Deployโ
# Docker
docker compose pull
docker compose up -d
# Kubernetes
kubectl set image deployment/gauzy-api api=ghcr.io/ever-co/gauzy-api:v1.X.X
Post-Upgradeโ
- Verify health โ
curl /api/health - Check logs โ No unexpected errors
- Test key features โ Login, time tracking, invoicing
- Monitor metrics โ Error rates, response times
- Verify data โ Spot-check recent records
- Update documentation โ If internal docs reference version
Rollback Planโ
If issues found:
- Revert database migrations
- Deploy previous image/tag
- Verify service health
- Investigate root cause
See Rollback Strategies for details.
Related Pagesโ
- Release Management โ release process
- Rollback Strategies โ rollback
- TypeORM Migrations โ migrations