Retool Workflows deployment

🎉

beta

Retool Workflows is currently in public beta. Sign up to get started →

All workflows are initially disabled by default. Workflows must be deployed and then enabled to run automatically. The Workflow editor automatically saves changes to your workflow but you must also deploy changes for them to take effect. This allows you to build a new workflow, or make changes to an existing one, without disruption.

You can disable a workflow at any time to stop it running automatically. You can also revert to the previously deployed version to roll back changes.

Deploy a workflow

Retool Workflows runs the most recently deployed version of a workflow when triggered. You must deploy a workflow whenever you make changes that need to take effect. The Workflow editor displays the current deployment status in the toolbar (e.g., Changes not deployed). Click Deploy to deploy your workflow.

Open the Deploy dropdown menu to view when the workflow was last deployed. If you want to revert the workflow to its currently deployed state, select Revert to last deployed version.

Enable or disable a workflow

You can enable or disable a workflow with the Enable toggle. Only enabled workflows run automatically. Disabled workflows do not run. You can always manually run a workflow from the Workflows editor, regardless of status.

Source Control for workflows

🚧

Source Control is only available to Enterprise users running Self-hosted Retool.

Source Control provides Retool organizations with the option to manage apps and workflows using pull requests on remote source control management (SCM) providers, such as GitHub. Rather than deploying a workflow, you create a pull request with the changes. Once the pull request is merged, the workflow will run automatically.

Considerations

Source Control for workflows operates similarly to how it does for apps, but with some key differences. Keep in mind the following considerations when using Source Control for workflows:

• No version history. Protected workflows do not have a versioned history and you cannot enable a specific version. Only the latest version can be enabled or disabled.
• Cannot be moved or renamed. Protected workflows and the folders in which they're located cannot be renamed or moved. You must unprotect workflows before making name or location changes.
• Branchless changes. Unlike Retool apps, you do not create a branch of a workflow from which to make changes. Once you update a protected workflow, a pull request is created immediately.