Upgrading¶

How to update AgenticAudit to a new version.

Docker Compose¶

# Pull latest code
git pull origin main

# Rebuild and restart
docker compose build
docker compose up -d

Alembic migrations run automatically on startup. The API will apply any new schema changes before accepting requests.

pip¶

pip install --upgrade agentaudit agentaudit-api

If you run the API server, apply migrations:

alembic upgrade head

From source¶

git pull origin main
uv sync

Apply migrations:

uv run alembic upgrade head

Pre-upgrade checklist¶

1. Back up your database before upgrading:

   docker compose exec db pg_dump -U agentaudit agentaudit > backup_$(date +%Y%m%d).sql
   

2. Check the changelog for breaking changes:

   cat CHANGELOG.md
   

3. Test in staging before upgrading production

Breaking changes policy¶

• Patch versions (0.1.x): Bug fixes, no breaking changes
• Minor versions (0.x.0): New features, backwards-compatible
• Major versions (x.0.0): May include breaking changes (documented in CHANGELOG.md)

Breaking changes are always documented with migration instructions.

Rollback¶

If something goes wrong:

# Docker: revert to previous image
docker compose down
git checkout <previous-tag>
docker compose build
docker compose up -d

Next steps¶

• Docker deployment — container configuration
• Database — schema and migration details