Configure a build
A build configuration defines the settings and requirements for creating a specific build of your project. A build configuration is a structured setup that determines how your project is compiled, packaged, and prepared for deployment across different platforms. Once a build configuration is created, you can run multiple build attempts against it. All the settings specified in the configuration, such as the platform, Unity version, and credentials automatically apply to every build attempt to ensure consistency and reproducibility across all builds.
To set up a build configuration:
- Sign in to the Unity Cloud Dashboard.
- Select DevOps > Build automation > Configurations.
Prerequisites
Before you set up your first build configuration, ensure your project’s source control settings are configured. This step is required for your first configuration.
Select Get started to configure your source control.
Choose a build configuration flow
You have two options to set up a new build configuration: quick target setup and target setup.
Quick target setup
If you select Quick target setup, the dashboard displays the basic configurations required to configure a build target for each platform. If you don’t want to configure advanced settings for your build target, select Quick target setup.
Target setup
When you select Target setup, you first set up the basic settings required for launching your build target. Then, you can either save your configuration or move to the advanced settings.
Basic Info
The Basic Info section includes fields to define core settings for your build:
| Setting | Description |
|---|---|
| Target name | Set a unique name for the build target configuration. |
| Branch | Choose the branch that Build Automation will pull from. |
| Project subfolder path (optional) | Specify the folder that contains the Assets and ProjectSettings if they’re not in the repository’s root. |
| Unity version | Select the Unity version you use. The Unity version controls the availability of several advanced settings like builder operating system and version, headless mode, etc. |
| Auto detect Unity version | Enable for Unity Build Automation to detect the Unity version from ProjectSettings/ProjectVersion.txt in your project. Ensure this file is included in your source control. |
| Builder Operating System and Version | Select the OS and version for your build machine. This is influenced by your platform. Refer to the Supported platforms on each builder OS for more information. |
| Xcode version (for macOS builders only) | This option appears when a macOS builder operating system is selected. Choose Default to use the default Xcode version for the selected OS. Refer to the Available Xcode versions guide for supported versions. |
| Unity Editor architecture (for macOS builders only) | Unity Build Automation specifies the Unity Editor architecture for builds running on a silicon-based operating system. |
Builder Configuration
Select the machine specifications for your build. The appropriate settings depend on your project’s complexity and platform requirements. For more details about builder configurations refer to Choose a machine specification.
Credentials
The Credentials section allows you to provide the credentials Build Automation uses to sign your build to ensure the security and integrity of your build artifacts. Provide the required credentials, such as keystores for Android or signing certificates for macOS.
Scheduling
The Scheduling section enables you to automate build triggers and set recurring build schedules.
| Setting | Description |
|---|---|
| Auto-build | Automatically start builds when changes are detected in the repository. |
| Auto-cancel | Automatically cancel pending builds if a new build triggers. |
| Build schedule | Configure a repeating build schedule with options such as interval, date, and time. |
For more details, refer to Run builds automatically.