Create a project in the Deploy app

Before you begin
  • Ensure that you have an Organization Admin or Organization Owner role in the organization where you want to create a project.

In the XM Cloud Deploy app, you create projects and environments, and set up deployment rules for each environment using the project creation wizard interface. The Deploy app supports both Azure DevOps and GitHub for source control.

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

The Deploy app provides templates to help you quickly set up an XM Cloud project. You can use these templates or your customized solution for the initial deployment to the environment you create for the project. You can also create a project using the Sitecore CLI or the XM Cloud Deploy API.

Project creation wizard

To create a project using the project creation wizard UI:

  1. Log in to the Deploy app.

  2. If you are an Organization Admin or Organization Owner in multiple organizations, click the organization where you want to create a project.

  3. On the Projects page, click Create project.

  4. Enter a name for your project, then click Continue.

  5. Choose the source control provider you want to use for your project by clicking Connect, then Continue.

    • If using the XM Cloud template - choose the provider where you want the Deploy app to create a new repository to store your environment code.

    • If using your own source code - choose the provider that contains your customized XM Cloud template repository.

  6. Choose the source code that will be used to create your environment.

    • Use XM Cloud template if you want to use an XM Cloud template for your environment's source code. It deploys your authoring and frontend together at the same time, in the same repository. We recommend this option even if you are migrating an existing site.

      Note

      The GitHub repository for the foundation template is available here.

    • Use your own code if you have customized an XM Cloud template repository and want to use this as the source for your project.

  7. Choose the source control provider account you want to use.

    • If you want to use an existing source control connection, in the Choose GitHub account or Choose Azure DevOps account drop-down menu, click the account you want to use.

    • If you want to use a new source control connection, click Connect to a new account, and follow the steps to authorize the Deploy app in your account.

  8. Choose the repository you want to use. If you are using Azure DevOps as your source control provider, you'll need to choose the Azure DevOps organization and project first.

    • If using the XM Cloud template, enter a name for the new repository, then click Continue.

      Note

      Your repository name can only contain alphanumeric characters, underscores, periods, or hyphens and a maximum of 100 characters. It must also follow the repository naming convention of your source control provider.

    • If using your own code, choose your customized XM Cloud template repository and the relevant branch, then click Continue.

  9. Enter a name for your environment, choose whether the environment is a production environment, and specify if you want to trigger an automatic deployment every time you push to the linked repository branch, then click Continue.

    Important

    A production environment is optimized for production traffic and is covered by the Sitecore SaaS Service Level Agreement. This setting cannot be changed later.

  10. Review your configuration and, if everything is set up correctly, click Start deployment.

    The deployment process then:

    • (If using the XM Cloud template) Creates a new repository in the connected source control account and copies the source code from the selected XM Cloud foundation template to the new repository.

    • Provisions the infrastructure and SaaS tenants to host the Content Management (CM) instance in the environment you defined.

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

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

    You can use the resulting repository to set up your full-stack XM Cloud local development environment or to get started with local development without Docker containers. When you create an environment, it appears as an XM Cloud app in the Sitecore Cloud Portal.

Do you have some feedback for us?

If you have suggestions for improving this article,