Skip to main content

Protect apps with Source Control

Learn how to protect apps with Source Control.

Use the following guide to protect your app by checking it into a remote source control repository.

Prerequisite: Configure Source Control​

Before you begin, ensure Source Control is configured for your Retool instance. This guide uses GitHub, but Retool supports multiple remote SCM providers. You must be an admin to configure Source Control.

Publish your app​

Apps must have one published version before they can be protected. Refer to the publishing guide for instructions on how to do so.

Protect your app​

There are two ways to protect your app: from the apps landing page, or from inside the app builder.

  1. From the apps landing page, select ··· > Protect app.
  2. Review the message, and click Protect app.
  3. Retool creates a branch with an initial commit for your app. Click Open pull request.
  4. Retool redirects you to your chosen Source Control Manager (SCM). Review your pull request, and confirm creation.
  5. When you're ready, merge the pull request to complete protection of your app.
  6. Return to the apps landing page. A confirmation modal appears confirming that protection is complete. Click Done.

Your application now shows a badge and Protected beside its name. Each protected app is stored as its own directory in your repository at the /apps-v2 path.

Refer to the Edit and publish protected apps guide to learn more about editing and publishing protected apps.

Remove protection​

You can remove protection for an app at any time. From the apps landing page, select ··· > Remove protection, then confirm changes in the modal that appears. A pull request will be opened to remove your app from the repository.