Docs
Powered by

Releases

Manage versions of your apps with release management. Track changes, control rollouts, and roll back when needed.

Understanding Releases

A release is a snapshot of your app at a specific point in time. Each release has:

  • Version number (e.g., v1.2.3)
  • Release notes describing changes
  • Timestamp when published
  • Status (draft, published, deprecated)

Creating a Release

From an App

  1. Open your app in Distribute → Integrations
  2. Click the Releases tab
  3. Click + New Release

Configure the Release

Field Description
Version Semantic version (major.minor.patch)
Title Short release name
Notes What changed in this version
Breaking Changes Mark if incompatible with previous

Example Release Notes

## v2.1.0 - Performance Update

### New Features
- Added batch processing for bulk operations
- New retry logic for failed API calls

### Improvements
- 50% faster data transformation
- Better error messages

### Bug Fixes
- Fixed date parsing in EU timezones
- Resolved memory leak in long-running jobs

Release Workflow

graph LR
    A[Development] --> B[Draft Release]
    B --> C[Testing]
    C --> D[Published]
    D --> E[Deprecated]

Release States

State Description
Draft Work in progress, not visible to users
Published Live and available for installation
Deprecated Still works but marked for removal
Archived No longer available

Semantic Versioning

Follow semantic versioning (SemVer) for clarity:

MAJOR.MINOR.PATCH

v1.0.0 → v1.0.1  (Patch: bug fix)
v1.0.0 → v1.1.0  (Minor: new feature)
v1.0.0 → v2.0.0  (Major: breaking change)

When to Bump Each

Change Type Version Bump Example
Bug fixes, typos Patch 1.0.0 → 1.0.1
New features (backward compatible) Minor 1.0.0 → 1.1.0
Breaking changes Major 1.0.0 → 2.0.0

Managing Releases

View All Releases

  1. Open your app
  2. Click Releases tab
  3. See version history with dates and status

Compare Releases

  1. Select two releases
  2. Click Compare
  3. See what changed between versions

Deprecate a Release

Mark old versions as deprecated to encourage upgrades:

  1. Open the release
  2. Click Deprecate
  3. Add migration notes
  4. Users see a warning to upgrade

Rollback

If a release has issues, roll back to a previous version:

Automatic Rollback

  1. Open the problematic release
  2. Click Rollback
  3. Select the target version
  4. Confirm rollback

Users are automatically migrated to the older version.

Manual Rollback

  1. Publish a new release with the old code
  2. Deprecate the broken release
  3. Notify users to reinstall

Release Channels

Distribute releases to different audiences:

Channel Purpose
Stable Production-ready releases
Beta Testing new features
Canary Early access, may have bugs

Configure Channels

  1. Open release settings
  2. Click Channels
  3. Enable desired channels
  4. Set update rules per channel

Best Practices