# Upgrade Checklist {#upgrade-checklist}


Step-by-step checklist for upgrading Ever Gauzy versions.


## Pre-Upgrade {#pre-upgrade}


- [ ] **Read release notes** — Check [changelog](https://sourcey-gauzy.pages.dev/reference/api-changelog/index.md) 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 {#during-upgrade}



### 1. Pull Latest Code {#1-pull-latest-code}


```bash
git fetch origin
git checkout v1.X.X  # or latest tag
```


### 2. Install Dependencies {#2-install-dependencies}


```bash
yarn install --frozen-lockfile
```


### 3. Run Migrations {#3-run-migrations}


```bash
# TypeORM
yarn typeorm migration:run

# MikroORM
npx mikro-orm migration:up
```


### 4. Build {#4-build}


```bash
yarn build:api
yarn build
```


### 5. Deploy {#5-deploy}


```bash
# 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 {#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 {#rollback-plan}


If issues found:

1. Revert database migrations
2. Deploy previous image/tag
3. Verify service health
4. Investigate root cause

See [Rollback Strategies](https://sourcey-gauzy.pages.dev/devops/rollback-strategies/index.md) for details.


## Related Pages {#related-pages}


- [Release Management](https://sourcey-gauzy.pages.dev/workflows/release-management/index.md) — release process
- [Rollback Strategies](https://sourcey-gauzy.pages.dev/devops/rollback-strategies/index.md) — rollback
- [TypeORM Migrations](https://sourcey-gauzy.pages.dev/database/typeorm-migrations/index.md) — migrations