Overview
There are three ways to create a release:| Source | Description |
|---|---|
| Git | Pull changes from a connected Git repository |
| Project | Copy flows from another project in your instance |
| Rollback | Restore a previous release state |
Prerequisites
Enabling Environments
In your project dashboard, go to settings then to Environments and hit the enable button.
Getting Started
Navigate to the Releases page from your project sidebar to view all releases and create new ones.
Connecting Git (Optional)
If you want to use Git to track your changes, you’ll need to connect a Git repository first. This requires the Environments feature to be enabled.Creating a Release
From Project
Apply changes from flows, connections and tables in one project to another.
From Git
Review Changes
A dialog will appear showing all the changes that will be applied:
- Flows Changes: New, updated, or deleted flows
- Connections Changes: New or renamed connections
- Tables Changes: New, updated, or deleted tables
Push Everything to Git
If your project is connected to a Git repository, you can push all your flows, connections, and tables to Git.
Pushing Individual Flows or Tables
You can also push specific flows or tables to Git without pushing everything.
Rolling Back a Release
If something goes wrong after applying a release, you can easily rollback to a previous state.
Release Details
Each release in the list shows:| Column | Description |
|---|---|
| Name | The name you gave the release |
| Source | Where the release came from (Git, Project, or Rollback) |
| Imported At | When the release was created |
| Imported By | The user who created the release |
Understanding the Changes Preview
When creating a release, you’ll see a preview of all changes:Flow Changes
- New flows that will be created
- Existing flows that will be updated
- Flows that will be deleted
Connection Changes
- New connections are placeholders and must be reconnected after the release
- Renamed connections
Table Changes
- New, updated, and deleted tables are shown with their respective indicators
Best Practices
Use Descriptive Names
Give your releases meaningful names like “v1.2.0 - Added email notifications” to easily identify them later.
Review Before Applying
Always review the changes preview carefully before applying a release to avoid unexpected modifications.
Test in Development
If using Git sync, test changes in a development project before deploying to production.
Document Changes
Use the description field to document what changed and why for future reference.
Permissions
To create and manage releases, you need the Write Project Release permission. Contact your instance administrator if you don’t have access to the releases feature.Troubleshooting
Environment settings are locked
Environment settings are locked
The Environments feature must be enabled on your instance plan to use Git sync. Contact your instance administrator to upgrade your plan or enable this feature.
Git connection fails
Git connection fails
- Verify your SSH private key is correctly formatted (ends with an endline), and make sure it has an empty phrase.
- Ensure the remote URL is in SSH format (not HTTPS)
- Check that the branch exists in the repository
No changes detected
No changes detected
If no changes appear when creating a release, it means your current project is already in sync with the source.
Connection placeholders
Connection placeholders
After applying a release with new connections, navigate to the Connections page and reconnect them with valid credentials.
Push Everything button not visible
Push Everything button not visible
Cannot find Environment settings
Cannot find Environment settings
Navigate to Project Settings from the sidebar, then click on Environment. If you don’t see this option, the Environments feature may not be enabled for your instance.