Create an XM Cloud project from existing source code in the XM Cloud Deploy app

In the XM Cloud Deploy app, you can create projects and environments and set up deployment rules for the environment using a graphical user interface.

To create a new project from existing code, you must have an administrator or owner role in an XM Cloud organization, and you must host your existing source code on a version control platform supported by the XM Cloud Deploy app.

When you create a project, you also create an environment and run an initial deployment to the environment.

When creating a new XM Cloud project, you can perform the initial deployment using your existing source code.

Tip

You can also create the project, environment, and initial deployment using the CLI.

To create a project from existing source code:

  1. Log in to your XM Cloud Deploy app account. If you are an organization admin or organization owner in multiple organizations, click the organization you want to create a project for.

  2. On the Projects page, click Create project.

  3. In the Create new project dialog, click Start from your existing XM Cloud code. then click Next.

  4. Click the source control provider and click Next.

  5. If you already created the source control connection you want to use, in the Select an existing GitHub connection drop-down menu, click the connection you want to use, and then click Next.

    If you haven't created your source control connection, click Create a new GitHub connection and follow your provider's instructions.

    Creating a new GitHub connection will install and authorize the Sitecore Deploy GitHub app on your personal account, organization, or enterprise. You need to Install & Authorize the Sitecore Deploy GitHub app for the repository that contains your existing code.

    • If you are a GitHub Organization member, you need to first Authorize & Request for the repository that contains your existing code. Then a GitHub Organization owner must Approve, Install, & Authorize your request for the repository that contains your existing code.

    • You cannot create a new GitHub connection with an Enterprise Managed User account.

  6. In the Project name field, enter the name you want for your project.

  7. In the Repository name field, enter a repository name to filter the list of your repositories and click the repository that contains your existing code, then click Next.

  8. In the Initial environment details dialog, in the Environment name field, enter the environment name, and in the Production environment field, choose whether the environment is a production environment.

  9. Optionally, in the Linked branch (optional) field, click a branch to link to the environment, and then, in the Trigger deployment on commit to branch drop-down menu, choose whether you want to trigger an automatic deployment every time you push to the linked repository branch.

  10. Click Create and deploy.

The deployment process then:

  • Provisions the infrastructure and SaaS tenants to host the CM instance in the environment that you defined.

  • Pulls the existing XM Cloud compatible source code from the GitHub repository to a hosted XM Cloud build server and builds the solution.

  • Deploys the XM Cloud build artifacts on the provisioned CM instance.

Do you have some feedback for us?

If you have suggestions for improving this article,