Using the Unity Editor to configure Unity Cloud Build for Git

Unity Cloud Build supports projects stored in Git repositories. Your repository can be hosted on GitHub, GitLab, Bitbucket, or private servers.

Note: This feature requires a subscription to Unity Teams Advanced. For more information, see the Unity Teams page.

Enabling Cloud Build

In the ServicesA Unity facility that provides a growing range of complimentary services to help you make games and engage, retain and monetize audiences. More info
See in Glossary window, next to Cloud BuildA continuous integration service for Unity Projects that automates the process of creating builds on Unity’s servers. More info
See in Glossary, click the OFF button to switch it ON.

In the CLOUD BUILD window, click the Cloud Build toggle to enable Cloud Build for your Project.

Setting the source control hosting type

In the services SOURCE CONTROL window:

1. From the SOURCE CONTROL HOST TYPE drop-down menu, select GIT.

2. In the SOURCE CONTROL HOSTING URL field, enter the URL of your Git repository. For information on the format of the URL, see the URL syntax section below.

3. Click Next.

URL syntax

To connect to your repository, you must specify the URL to your Git server. You can specify the URL to use the following protocols:

• HTTPS

• GIT

• SSH

The following are examples of URLs for GitHub, bitbucket, and GitLab:

• https://github.com/youraccount/yourrepo

• git://github.com/youraccount/yourrepo.git

• git@bitbucket.org:youraccount/yourrepo.git

• git@gitlab.com:youracccount/yourrepo.git

If you are hosting Git on a private server, you must use SSH to connect to your repository.

Use the format that is most convenient for you. Unity Cloud Build automatically re-writes the URL into the format it needs.

When Unity Cloud Build connects to the hosting site, it automatically detects whether your repository is public or private. If your repository is public, Unity Cloud Build automatically connects to it and you can skip to the Setting up your target platform section below.

Using private repositories

If your repository is private, Cloud Build must use SSH to connect to it. When Cloud Build detects that the repository is private, it displays the Grant us access to your source control window.

Setting your SSH key on GitHub

To add your SSH key to your project in GitHub:

1. Sign in to GitHub.

2. In the upper-right corner of any GitHub page, click your profile photo, then click Your profile.

3. On your profile page, click Repositories, then click the name of your repository.

4. In your repository, click the Settings tab.

5. In the sidebar, click Deploy keys, then click the Add deploy key button.

6. In the Title textbox, type name to identify this key.

7. In the KeyCan refer to an Input Key or an Animation Key
   See in Glossary field, paste in your public key from the Grant us access to your source control screen, and then click the Add key button.

For more information on deploy keys, see Managing Deploy Keys in the GitHub documentation.

You can also add your SSH key to your GitHub account so that all repositories in your account are accessible to Cloud Build. For more information, see Adding a new SSH key to your GitHub account in the GitHub documentation.

Setting your SSH key on Bitbucket

To add your SSH key to your Bitbucket account:

1. Sign in to Bitbucket.

2. Click your avatarAn interface for retargeting animation from one rig to another. More info
   See in Glossary in the lower left of the page.

3. Click Bitbucket Settings.

4. On the Settings page, in the SECURITY section, click SSH keys.

5. In SSH keys, click the Add key button.

6. In the Label field, enter a recognizable name for the key (such as Unity Cloud Build.)

7. Paste the Unity Cloud Build SSH key from the Grant us access to your source control screen into the Key field.

8. Click Add key.

On the Grant us access to your source control screen, click Next: Target Setup.

Setting up your target platform

To configure the runtime platform for your app in the Unity Editor, go to the Services window and make the following changes:

1. From the TARGET LABEL drop-down menu, select a build platform.

2. From the BRANCH drop-down menu, select the branch from which to build your project. The default branch in most Git repositories is “master”. If you are building for multiple build targets, you can configure a different branch for each build target.

3. In the PROJECT SUBFOLDER field, enter the the folder in your project that contains your Unity project; specifically the AssetsAny media or data that can be used in your game or Project. An Asset may come from a file created outside of Unity, such as a 3D model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
   See in Glossary and ProjectSettings folders. The path to the folder is typically similar to the following:

NewGameProject/Src/UnityProject/

If your Unity project is not at the root of your repository, you must complete the PROJECT SUBFOLDER field.

1. Optionally, uncheck the AUTO-BUILD checkbox if you do not want Cloud Build to automatically build your Project when you make changes to your Project. For more information, see Automated Build Generation.

Git submodules

If your project is using private Git submodules, make sure that the URLs present in your .gitmodules file are using the git@ syntax instead of https:// or git://.

For example:

• git@github.com:youraccount/yourrepo.git (for GitHub)

• git@bitbucket.org:youraccount/yourrepo.git (for Bitbucket)

• git@gitlab.com:youracccount/yourrepo.git (for GitLab)

2018–04–10 Page published