Deploying Changes

How to Deploy changes between a local machine and an environment with Umbraco Deploy using either a Git GUI or CLI

In this article, you can learn more about deploying your code changes and metadata from a local instance to your Cloud environment.

Local changes in your Umbraco Cloud project are automatically detected and synced with your Git client for seamless collaboration.

There are two ways this can be done. You can push the changes using a Git GUI or your terminal. This guide will show how you can use both ways to deploy your local changes to Umbraco Cloud.

Prerequisites

• A clone of your Cloud project.

• A Git GUI or a Terminal.

• Created some Document Types and Data Types with corresponding .uda files.

  • The files are located in the /umbraco/Deploy/Revision folder.

Deploying using a Git GUI

Once you have created some Documents and Data types, follow the steps below to deploy your local changes using a Git GUI. The guide will use Fork as the Git GUI, however you can use your own preferred Git GUI.

1. Go to your Git GUI.

2. Check for local changes in your GUI.

Local changes in Git GUI.

1. Prepare changes, so they are ready to be committed.

   1. Write a commit subject

   2. Write a description of the commit.

   3. Commit the files.

Ready the files for commit.

1. Push the files to your cloud project in the GUI.

Push changes to Umbraco Cloud.

The deployment will kick in and the new Documents and Data Types you have created locally are now automatically created on the remote environment.

After deploying changes locally to your Cloud environment, use the Umbraco Cloud portal's 'Deploy changes to ..' button for subsequent deployments to other environments. For more information, see the Deploying between Cloud Environments article.

Deploying local changes using the terminal

To deploy your local changes from local to Umbraco Cloud using a terminal follow the steps below:

1. Navigate to your local projects folder using the cd YourProjectName command in the terminal.

2. Check for pending changes in your project with git status

3. Add the pending changes with git add -

4. Commit the staged files using git commit -m "Adding updated schema changes"

5. Push the changes to Umbraco Cloud using git push.

   1. Do a git pull if the push is rejected.

If you have to pull down, make sure to see if any of these commits contain changes to the schema (anything in umbraco/Deploy/Revision/).

To validate your local site and ensure compatibility with the updated schema, use the Deploy Dashboard in the Settings section of the Umbraco backoffice.

Here, you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and is in progress has been completed, or has failed.

The dashboard will show the status based on the marker files on the disk, eg. deploy-progress. From the Deploy Dashboard, it is also possible to trigger different processes.