Navigation
  • Stitch >
  • Application Deployment

Application Deployment

On this page

Introduction

Stitch uses a deployment-based versioning scheme that allows you to group updates to your application and make them available to client applications at the same time. You can deploy a new version of your application with multiple deployment methods that each fit a particular development workflow. You can also review the historical state of your application based on the built-in deployment history log.

Concepts

Deployment Methods

You can deploy new versions of your application through the Stitch UI or one of multiple code-based deployment methods that each suit a particular development workflow.

Deployment Method Details
Stitch UI

Use This Method If

  • You want to use a browser-based GUI to develop and manage your Stitch app.

Deployment Pattern

For a detailed walkthrough, see Deploy from the Stitch UI

  1. Make changes in the UI that are saved in a draft state and not visible to client apps.
  2. Review all draft changes and then deploy them together through the Stitch UI.
Automatic GitHub Deployment

Use This Method If

  • You want to use a code-first approach to app development.
  • You want to use Git to version control your app.
  • You want to automatically deploy changes based on the master branch of a GitHub repository.

Deployment Pattern

For a detailed walkthrough, see Deploy Automatically with GitHub

  1. Host your exported application repository on GitHub.
  2. Add, remove, or modify configuration files in a local clone of the repository to specify your updated application.
  3. When you’ve made all the changes that you want to, commit them and push to the GitHub. Automatically deploy the most recent version of a specific branch.
Stitch CLI

Use This Method If

  • You want to use a code-first approach to app development.
  • You want to use a command line interface to manage and deploy your Stitch app.

Deployment Pattern

For a detailed walkthrough, see Deploy Changes with Stitch CLI

  1. Export a copy of your application to a directory of configuration files and download it to your computer.
  2. Add, remove, or modify configuration files in the directory to specify your updated application.
  3. When you’ve made all the changes that you want to, manually deploy them by importing the updated application directory.
Stitch Admin API

Use This Method If

  • You want to use a code-first approach to app development.
  • You want to use an HTTP API to manage and deploy your Stitch app.

Deployment Pattern

For a detailed walkthrough, see Draft and Deploy a Group of Changes

  1. Create a new draft deployment through the API.
  2. Add, remove, or modify components of your application by calling relevant HTTP endpoints.
  3. When you’ve made all the changes that you want to, deploy the draft through the API.

Application Components

Stitch applications are composed of components like Functions, Triggers, Auth Providers, Services, and Values. A deployment consist of at least one new, updated, or deleted component.

Configuration Files

Stitch uses configuration files to define your application’s metadata and components. Every component is defined by its own configuration file and each type of component uses a distinct configuration file schema. The Stitch UI manages your application’s configuration files for you, but you can also use a code-based deployment method to update your application by adding, modifying, and deleting configuration files directly.

Application Directory

Stitch applications are structured in a nested directory format called an application directory that contains configuration files for your application components. The configuration files are grouped into directories based on their component type. You can download a copy of the application directory for the most recently deployed version of an app by exporting it from the Stitch UI or Stitch CLI; or by cloning the underlying Git repository.

For additional information on the structure of an application directory as well as the schema of each configuration file type, see Application Configuration Files.

Deployment History

Stitch logs every deployment of an application and exposes a list of the 100 most recent deployments in the History tab of the Deploy in the Stitch UI. Each deployment log includes data about a set of changes, such as their status, origin, and time of deployment.

If you choose to deploy through the Stitch UI, any changes you make are grouped in a row at the top of the deployment history table that represents draft changes made since the previous deployment. You can use the Action buttons on this row to manually deploy all draft changes.

The table of application deployment history logs in the Stitch UI

Related Content

Deployment Guides

Guide Description
Deploy from the Stitch UI Learn how to make changes through the Stitch UI and then deploy them simultaneously as a new version of your app.
Deploy Automatically with GitHub Learn how to automatically deploy new versions of your app based on the latest commit of a GitHub repository.
Deploy Changes with Stitch CLI Learn how to deploy new versions of your app by pushing changes by importing application configuration files from the command line.

Reference Documentation

Guide Description
Stitch CLI Learn about the Stitch command line interface, including how to install it and use it to manage your applications.
Application Definition Files Learn the structure and schema of Stitch application directories and configuration files.
Export a Stitch App Learn how to get an application directory that matches the latest version of a Stitch app.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.