Manage connections for source control and hosting providers

On the Connections page, you can view, create, and delete your source control connections and hosting provider connections.

The connections page.

A source control connection grants access to the repositories containing the XM Cloud environment code you want to deploy or gives the Deploy app permission to create repositories in your source control system.

The Deploy app supports the following source control provider:

  • GitHub

A hosting provider connection gives the Deploy app permission to deploy XM Cloud websites with your hosting providers.

The Deploy app supports the following hosting provider:

  • Vercel

Creating a source control connection with GitHub

If you want the Deploy app to access the GitHub repositories containing your XM Cloud environment code or create repositories in your GitHub account, you need to create a source control connection.

When you create a source control connection with GitHub, you have two options:

  •  Install & Authorize the Sitecore Deploy GitHub app for the selected repositories - choose this option when you have existing code and you want to limit the Deploy app's access to specific GitHub repositories.

  •  Install & Authorize the Sitecore Deploy GitHub app for All repositories - choose this option if you want the Deploy app to have access to all your GitHub repositories and create repositories on your behalf. Required when you choose the foundation template in the project creation wizard because the Deploy app creates a new repository for the foundation template code.

Note

If you want to use the foundation template while limiting the Deploy app's access to your GitHub repos, you can:

  1. Clone the foundation template repository.

  2. In the Deploy app, create a source control connection for the GitHub account where you cloned the Foundation Template and Install & Authorize the Sitecore Deploy GitHub app for the repository that contains the foundation template.

  3. In the project creation wizard, create a project using existing code and choose the source control connection and repository that you cloned.

To create a source control connection with GitHub:

  1. On the navigation pane of the Deploy app, click Connections.

  2. On the Connections page, click Create connection > GitHub.

  3. Choose the GitHub account or organization where you want to install and authorize the Deploy app.

  4. Creating a new GitHub connection will install and authorize the Sitecore Deploy GitHub app on your personal account, organization, or enterprise.

    • If you only want to create projects from existing source code, you need to Install & Authorize the Sitecore Deploy GitHub app for the repositories that contain your existing code.

    • If you also want to create projects from the foundation template, you need to Install & Authorize the Sitecore Deploy GitHub app for All repositories.

    • If you are a GitHub Organization member, you must first Authorize & Request the Sitecore Deploy GitHub app. Then a GitHub Organization owner must Approve, Install, & Authorize your request.

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

    • All GitHub repositories created by the Deploy App have private visibility.

Note

You can also create a source control connection when you create a project in the XM Cloud Deploy app.

Delete a source control connection

You can delete a source control connection that you don't need. You cannot delete a source control connection that is associated with a project.

To permanently delete a source control connection:

  1. On the navigation pane of the Deploy app, click Connections.

  2. On the Connections page, locate the source control connection you want to delete, then click Actions > Delete.

  3. In the Delete connection dialog, click Delete.

Create a hosting provider connection

You can create a hosting provider connection to give the Deploy app permission to deploy XM Cloud websites with your hosting providers.

To create a hosting provider connection:

  1. On the navigation pane of the Deploy app, click Connections.

  2. On the Connections page, on the Hosting tab, click Create connection, then click the hosting provider you want to create a connection for.

  3. Follow the hosting provider's steps to create a new connection.

Delete a hosting provider connection

You can delete a hosting provider connection that you don't need. If you delete a Vercel connection that was used to set up hosting for a site, the Deploy app can't delete the Vercel project associated with that site.

To permanently delete a hosting provider connection:

  1. On the navigation pane of the Deploy app, click Connections.

  2. On the Connections page, on the Hosting tab, locate the hosting provider connection you want to delete and click Actions > Delete connection.

  3. In the Delete connection dialog, click Delete.

Do you have some feedback for us?

If you have suggestions for improving this article,