Build Automation settings#

You can configure all Build Automation settings and configurations from the Unity Cloud Dashboard > Products > DevOps > Build Automation.

General#

The general settings tab allows you to configure the following settings:

Account settings#

Organization settings#

Project settings#

Source control#

To use Build Automation with your projects, you must first host your project in a source control system (also known as a version control system). Unity Build Automation supports:

• Unity VCS
• Git
• Azure
• Apache Subversion (SVN)
• Perforce

The following shows you how to set up source control for Build Automation.

Configure Build Automation for Unity VCS#

Unity Build Automation supports projects stored in Unity VCS repositories.

Note: This product requires a subscription to Unity DevOps.

1. From the Build settings, select the Source control tab.
2. From the drop-down, select Unity VCS.
3. In the source control provider URL field, add the URL to your Unity VCS cloud server or select from the list of available organizations.
4. Select Authenticate with Unity ID, or Authenticate with username or password.
5. If you select Authenticate with username or password, enter the Username and Password for your Unity VCS server.
6. Select an Authentication Type from the dropdown.
7. If your repository is encrypted, check the My repository is encrypted box. a. Add the Encryption key. b. Add the Encryption method.
8. Select Save.

Configure Build Automation for Git#

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

This topic covers:

• Configure Git in the Dashboard
• Use private repositories

Configure Git in the Dashboard#

You can configure access to your repository using the following authorization protocols:

• Personal Access Tokens (default)
• SSH

To configure Build automation to use OAuth to access your repository:

1. From the Build settings, select the Source control tab.
2. From the drop-down, select GitHub, Bitbucket, or GitLab.
3. Generate a Personal Access Token from your Git provider.
4. Enter your token and select Authorize so Unity can access your provider account.
5. Select your preferred repository from the drop down.
6. From the Build settings page, select Save.

For the next step, see Setting up a target build platform.

To configure Build Automation to use SSH to access your repository:

1. In the Source control tab, from the drop-down > Manual setup, select Git.
2. In the source control provider URL field, add the URL to your Git server.

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

• https://github.com/youraccount/yourrepo
• git@bitbucket.org:youraccount/yourrepo.git
• git@gitlab.com:youracccount/yourrepo.git

1. Once the setup is complete, on the Source control tab, select Save.

When Build Automation connects to the hosting site, it automatically detects whether your repository is public or private. If your repository is public, Build Automation automatically connects to it, and you can skip to create a build target. If your repository is private, complete the steps below.

SSH and private repositories#

If your repository is private an SSH key must be configured for Build Automation to connect to it. When Build Automation detects that the repository is private, it displays the Grant us access to your source control screen. Complete the steps in the window to grant access.

Configure Build Automation for Azure#

Unity Build Automation supports projects stored in Azure repositories.

Configuring Azure on the Dashboard#

1. From the Build settings page, select the Source control tab.
2. From the drop-down, select Azure.
3. Add your Azure Organization.
4. Add the Azure Project that the code repository belongs to.
5. Create and provide your Azure Personal Access Token.
6. Select Authorize to allow Unity to retrieve your repositories.
7. Select Save.

Configure Build Automation for Apache Subversion (SVN)#

Unity Build Automation supports projects hosted in Apache Subversion (SVN) repositories.

1. From the Build settings page, select the Source control tab.
2. From the drop-down > Manual setup, then select SVN.
3. In your SVN server, create a read-only user account just for Unity Build Automation, along with a secure password.
4. From the Build settings page, enter the new username and password in the fields.
5. Select Save.

Public SSH Keys

Build Automation does not support connecting to your SVN repository using a public SSH Key. Use a username and password instead.

SSL Certificates

Self-signed SSL certificates are not supported. Build Automation does not support an SSL handshake with a server with a self-signed certificate. The hostname in the certificate must match the hostname accessed by Build Automation.

Configure Build Automation for Perforce#

Unity Build Automation supports Projects stored in Perforce repositories.

Configuring Perforce on the Dashboard#

1. From the Build settings page, select the Source control tab.
2. From the drop-down > Manual setup, then select Perforce.
3. In the source control provider URL field, enter the URL of your Perforce server. You can specify the URL to use the https:// or SSL protocols. The following are examples of valid URLs:
   • https://127.0.0.1:1667
   • ssl:127.0.0.1:167
4. In P4, create a user with read-only access to your repo.
5. From the Build settings page, enter the username and password in the fields.
6. Select Save.

Next steps#

Create a build target