A Release is an object in Amplitude that represents a change in your product. It can represent a major update like the launch of a new feature, a minor patch to fix a small bug, or even the launch of an experiment. With Releases, you can easily see a marker in your time-series charts indicating when a release occurred.
If you're on one of our paid plans, Amplitude creates Releases for you automatically, but you can also create them manually.
- A release must follow semantic versioning format:
major.minor.patch where .patch is optional
- For example, [Amplitude] Version = 12345 will not automatically create a release, but [Amplitude] Version = 123.45.6 will
- Development projects, i.e Projects that contain names like "Test", "Development", "Staging" etc. are excluded
- If you are sending event data server side via our HTTP/Batch API, use the app_version user property.
Configuring Automated Releases
Automated Release detection can be configured via the Release Timeline view. As an Admin or Manager, click the settings icon in the top right next to "Add a Release." Release settings allow you to enable or disable automatic Release detection, as well as whether or not Releases are automatically annotated.
Reminder: Automated releases is available for Scholarship, Growth, and Enterprise plans only.
- Name: The name of the Release. This is visible on Charts and in the Release Timeline view
- Descriptions: What changed in the Release. This is visible in the Release Timeline view and is helpful content for your team.
- Version: The [Amplitude] Version User property that defines the product change. This field allows Amplitude to show you what new Events were introduced in that Release via the Release Report. The Version field selected needs to 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 [Amplitude] Platform(s) this Release is applicable 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 deploy processes.
Editing a Release
Releases that have been manually created or automatically detected can be edited to add additional context and information to the Release. Click the Edit button in the top right to change things like the definition of the Release or add more detail to the "About" section.
By default, all Releases that are created are visible across all Charts. You can toggle the visibility of a Release from the Release Report page or the Release Timeline view.
Viewing Release Reports
Adding Items to a Release
The "Analysis" section is where you can link to other content that has been created in Amplitude. This makes it really easy for others in your Organization to understand how the experiences your team is launching have been performing and what impact they are having.
Use Releases as a great way to distribute both context and outcomes across your team.
To attach items to a release, click the "Add Item" button in the "Analysis" section of the Release Report.