Docs Menu

Deploy from the Realm UI

On this page

  • Overview
  • Procedure
  • Make Changes to Your Application
  • Review Draft Changes
  • Deploy a New App Version

When you make changes to your application through the Realm UI, those changes are saved in a draft state. Draft changes do not affect your production application and are invisible to end users. This is particularly useful in situations where you need to make related changes to multiple components in your application and want to avoid bugs and a loss of functionality during the transition. When you want to publish your changes, you can manually deploy them through the Realm UI.

1

Start by making any additions, modifications, or deletions that you want to include in the deployment through the Realm UI. If you have drafts enabled, your changes will be saved automatically as a draft.

Tip
See also:
Note

You can only create draft changes through the Realm UI or Admin API. Any changes that you make with GitHub or the Realm CLI are deployed independently of draft changes. To avoid possible conflicts or inconsistencies, its best to make your changes in one place at a time.

2

You can review all of the draft changes to your application prior to deploying them.

Click Deployment in the left navigation menu to navigate to your app's deployment history table. The top row of the table represents all of the draft changes that you've made since the previous deployment.

Click the Review Draft and Deploy button in the top row to see a diff of the underlying app configuration files that represents the draft changes that you've made.

Note

You may want to download a draft of your changes because of merge conflicts or to save the draft outside of the UI. You can do so in the Review Draft and Deploy modal by clicking Export State in the top right corner. You can use the download to deploy your changes in the realm-cli or as a reference as you reapply changes in the UI.

3

After you've reviewed your draft changes and confirmed that you want to deploy them, click Deploy. Realm deploys a new version of your application that includes the draft changes. Client applications will automatically use the newest version, so make sure that you also update your client code to use the new version if necessary.

Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.