Creating and Editing Build Configurations

This section details creating build configurations via the TeamCity web UI. Other options include the REST API and using TeamCity project configuration in DSL based on the Kotlin language.

TeamCity provides several ways to create a new build configuration for a project using the Project Settings page:

You can create a new build configuration

• Manually

• Creating-New-Build-Configuration-from-URL

• Pointing to a GitHub repository

• Pointing to Bitbucket repository

• Create a build configuration template, and then create a build configuration based on the template.

When build configurations are created, you can:

• change their order

• edit their settings

Creating New Build Configuration Manually

1. On the Administration > Projects page, select the desired project in the list. (Alternatively, open the project using the Projects popup, and click the Edit Project Settings link on the right). The Project Settings page opens.

2. On the Project Settings page, Build Configurations section, click Create build configuration.

3. In the Create Build Configuration dialog, specify the name, id and (optionally) description for the build configuration, click Create.

4. Proceed with creating other settings:

   • Create/edit VCS roots and specify VCS-specific settings

   • On the Build Steps page, configure build steps discovered by the automatic detection. ro create them manually by selecting a desired build runner from the drop-down list. Click Save. You can add as many build steps as you need within one build configuration. Note that they will be executed sequentially. In the end, the build gets the merged status and the output goes into the same build log. If some step fails, the rest is executed or not, depending on their step execution policy.

   • Additionally, configure build triggering options, dependencies, properties and variables and agent requirements.

Creating New Build Configuration from URL

You can create a build configuration using a VCS URL:

1. On the Administration > Projects page, select the desired project in the list. (Alternatively, open the project using the Projects popup, and click the Edit Project Settings link on the right). The Project Settings page opens.

2. On the Project Settings page, Build Configurations section, click Create build configuration from URL.

3. In the Create Build Configuration dialog, s pecify a VCS repository URL and, if authentication is required, VCS credentials. Click Create.

4. TeamCity will suggest the build configuration name and will configure the rest of settings for you.

   • it will determine the type of the VCS repository and create a VCS root.

   • TeamCity will attempt to auto-detect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects. If none found, you will have to configure build steps manually.

   • Next, TeamCity UI will display suggestion icons with prompts to create build triggers, failure conditions and build features. Depending on the build configuration settings, it may suggest some additional configuration options.

5. After the build configuration is created, you can run a build and/or tweak the settings.

Creating  New Build Configuration pointing to GitHub.com repository

1. Click the Create build configuration button and select Pointing to GitHub.com repository.

   • If you do not have a GitHub connection configured, you will be redirected to the Connections page. Set up the connection as  described here, then follow the steps below.

   • If you have a GitHub connection configured, follow the steps below.

2. On the Create Build Configuration From GitHub page, select a repository. TeamCity will verify the repository connection. If the Connection is verified, the new page opens.

3. TeamCity will display the project and build configuration name. If required, modify the names and click Proceed.

4. TeamCity will add a VCS build trigger and attempt to auto-detect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects. On the Auto-detected Build Steps page, select the step(s) to use in your build configuration. Click Use selected. If no steps found, you will have to configure build steps manually.

5. Your project and a build configuration are configured. Click the Run button to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review the suggested settings and configure required ones.

Creating  New Build Configuration pointing to Bitbucket Cloud

1. Click the Create build configuration button and select Pointing to Bitbucket Cloud repository.

   • If you do not have a Bitbucket connection configured, you will be redirected to the Connections page. Set up the connection as  described here, then follow the steps below.

   • If you have a Bitbucket connection configured, follow the steps below.

2. On the Create Build Configuration From Bitbucket Cloud page, select a repository. TeamCity will verify the repository connection. If the Connection is verified, the new page opens.

3. TeamCity will display the project and build configuration name. If required, modify the names and click Proceed.

4. TeamCity will add a VCS build trigger and attempt to auto-detect build steps: Ant, NAnt, Gradle, Maven, MSBuild, Visual Studio solution files, PowerShell, Xcode project files, Rake, and IntelliJ IDEA projects. On the Auto-detected Build Steps page select the step(s) to use in your build configuration. Click Use selected. If no steps found, you will have to configure build steps manually.

5. Your project and a build configuration are configured. Click the Run button to start the build. Depending on the build configuration settings, TeamCity can suggest some additional configuration options. Review the suggested settings and configure required ones.

Creating Build Configuration Template

Creating a new build configuration template is similar to creating a new configuration:

1. On the Administration > Projects page, select the desired project in the list. (Alternatively, open the project using the Projects popup, and click the Edit Project Settings link on the right). The Project Settings page opens.

2. On the Project Settings page, Build Configuration Templates section, click the Create template button and proceed with configuring general settings, VCS settings and build steps.

Alternatively, you can create a build configuration template from an existing build configuration:

1. Open the existing build configuration settings page, click Actions at the top right corner of the screen, and select the Extract Template option.

2. Specify the settings required and click Create.

Creating Build Configuration From Template

To create a build configuration based on a template:

1. On the Administration > Projects page, select the desired project in the list. (Alternatively, open the project using the Projects popup, and click the Edit Project Settings link on the right). The Project Settings page opens.

2. On the Project Settings page, Build Configuration Templates section, locate the desired template and click its name or use Edit.

3. Click Actions at the top right corner of the screen, and select Create Build Configuration.

4. Specify the required settings for the new configuration.

Alternatively, you can create a build configuration based on a template as follows:

1. On the Administration > Projects page, select the desired project from the list. (Alternatively, open the project using the Projects popup, and click the Edit Project Settings link on the right). The Project Settings page opens.

2. On the Project Settings page, Build Configurations section, click Create build configuration.

3. On the configuration settings page, use the Based on template drop-down and select a template for your build configuration.

Ordering Build Configurations

You can view all build configurations of a project on the Project Overview page listed in alphabetical order by default. Administrators can customize the default order.

Configuring Settings

Configuring settings of a build configuration is described on the following pages:

Note that editing via the TeamCity Web UI will be disabled for build configurations created via the REST API.