Source Control allows organizations to manage changes to their Retool applications using pull requests on remote source control management (SCM) providers, such as GitHub and GitLab. Instead of making changes directly to an application, changes are made on a separate branch.
Once changes are ready to review, they're committed and pushed to a remote SCM provider, where the author can open up a pull request against the protected branch. When code review is complete and you merge the changes into the main branch, your Retool instance(s) pull in the changes from the main branch and update the application.
Source Control is best suited for critical Retool applications in need of additional redundancy. This can help avoid breakages that cost your team time and effort.
Retool Roundtable: Build apps with branch-based editing
- Branch-based workflow: All changes to apps under Source Control start on a branch first. Changes are reviewed through pull requests and reviewers can test out the changes before merging them in. This process prevents accidental changes and broken applications.
- Multi-file applications: Instead of a single large YAML file, applications are split into components, each with their own YAML file. This split simplifies code reviews and prevents most merge conflicts.
- Native API support: Source Control integrates directly with the remote SCM provider's API. Branches and commits are pushed directly to your repository. Retool uses API authentication strategies that only need access to a single repository, not your entire organization.
Each SCM provider for Source Control has minimum version requirements on the version of Retool that is supported. You must be running a version of Retool that meets the provider's requirement.
Updated 3 days ago