Release Management Workflow

Release Process

Diagram source

graph LR
    Dev[develop] -->|Feature freeze| RC[Release Candidate]
    RC --> QA[QA Testing]
    QA -->|Pass| Tag[Tag Release]
    QA -->|Fail| Fix[Fix & Retest]
    Fix --> QA
    Tag --> Build[Build Artifacts]
    Build --> Deploy[Deploy to Prod]
    Deploy --> Monitor[Monitor]

Version Numbering

Gauzy follows Semantic Versioning (SemVer):

Release Checklist

Pre-Release

• All features merged to develop
• All tests passing
• Version bumped in package.json
• Changelog updated
• Documentation updated
• Database migrations tested

Release Day

• Create release branch from develop
• Final QA on staging
• Tag release in Git
• Build Docker images
• Deploy to production
• Verify health checks
• Monitor error rates

Post-Release

• Merge release branch to main
• Merge back to develop
• Announce release
• Update documentation site
• Close related issues/PRs

Rollback Process

If critical issues found:

1. Revert to previous Docker image tag
2. Or: kubectl rollout undo deployment/gauzy-api
3. Investigate and fix
4. Re-release as patch

Related Pages

• CI/CD Pipeline — CI/CD
• Blue-Green Deployment — zero-downtime
• Hotfix Workflow — emergency fixes