In Amplitude, a release represents a change in your product. It can be a major update like the launch of a new feature, a minor patch to fix a small bug, or the launch of an experiment. Releases are shown as a marker in your time-series charts when they occur.
Amplitude automatically creates releases for all customers on paid plans, but you can also create them manually.
Create a release
Versionuser property. When a new value is detected, Amplitude automatically creates a release the next day. It applies the following heuristics when creating a new release:
- A release must follow semantic versioning format:
.patchis optional. For example,
Version = 12345will not automatically create a release, but
Version = 123.45.6will.
- Development projects (projects that contain names like "Test", "Development", "Staging," etc.) are excluded from automatic release generation.
- If you are sending event data server side via Amplitude's HTTP/Batch API, use the app_version user property.
Automated releases will not be created retroactively for backfilled data.
Configure an automated release
You can configure automated release detection in the Release Timeline frame, if you are an Admin or Manager. Simply click the settings icon to gain access to the Project Settings fly-out panel. Here you can enable or disable automatic release detection and automatic annotation.
- Name: The name of the release. This is visible on charts and in the Release Timeline view.
- Descriptions: The product change brought about in the release. This is visible in the Release Timeline view.
- Version: The
Versionuser property that defines the product change. Amplitude uses this field to show you any new events introduced in the release, via the Release Report. The Version field selected must be an existing value in your data.
- Release Date: The date the release was shipped.
- End Date: The end date of the release rollout.
- Platform(s): The
Platform(s) this release applies to.
- Visibility: Whether the release is visible on all charts or not.
Releases can also be created programmatically by using the Releases API. This allows you to integrate the creation of releases into your own internal deployment processes.
Edit a release
Releases that have been manually created or automatically detected can be edited to add additional context and information to the release. To do so, open the release from within the Release Timeline view and click Edit.
By default, all releases are visible across all charts. You can toggle the visibility of a release from the Release Report page (this view), or the Release Timeline view.
The Release Report
Add items to a release
You can link to other Amplitude content via the Analyses section. This makes it easy for others in your organization to understand how the experiences you've launched have performed, and the impact they've had on your users.
Use releases to distribute both context and outcomes across your team.
To attach items to a release, click + Add Item in the Analyses section of the Release Report.