TeamCity
 
2.1
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. TeamCityReference
  3. Reference
  4. UI Reference
  5. Administration
  6. Create Edit Build Configuration

Create Edit Build Configuration

Last modified: 20 April 2023

Create or Edit Build Configuration



Administration > Create build configuration or Administration > <project> > Create build configuration

General Settings page



Option

Description

Name

Use this mandatory text field to specify or change build configuration name.

Description

Use this text field to specify optional description of the build configuration.

VCS checkout mode

Select the desired checkout mode from the drop-down list. Available options are:

  • Automatically on server - TeamCity server will checkout sources and pass them to the agent before each build

  • Automatically on agent - Build agent will checkout sources before the build

  • Do not checkout files automatically - TeamCity does not checkout sources. To build latest version of the sources, they should be checked out as part of the build script. Please note that this mode can cause inaccuracy in reporting changes.

Build options

Clean all files before build

Check this option to remove all residual information left by the build runner, that might impede the next build of the same configuration, running on the same agent. If this option is checked, TeamCity performs full checkout of the entire project before each build.

Fail build if at least one test failed

Check this option to mark build as failed, if at least one test failed. If this option is not checked, the build can be marked successful even with the failed tests.

Enable execution timeout

Check this option to enable time control of the build. If the specified period of time in minutes is exceeded, the build is automatically canceled. This option helps you tackle with the hanging builds.

Number of simultaneously running builds

Specify the limiting number of builds of the same configuration that can run simultaneously on all agents. This option helps avoid such situation, when during active development of a project all agents are busy with the builds of a single project.

Build number format

Specify the format of Basic Concepts. The pattern can refer to:

  • build counter: pattern {0} is replaced with increasing build counter value.

  • VCS changeset: pattern {build.vcs. number. 1} is replaced with actual changeset number from the VCS. Since TeamCity supports several VCS for each project, there could be {build.vcs. number. 2} and more, depending on the number of VCS used.

    tip

    1.0.{0}.{build.vcs.number.1}

Build counter

Specify the starting number. Use the Reset counter link to reset counter value to 1.

Enable status widget

Check this option to enable retrieving status of the latest build for one or several build configurations by any web page so that it is always possible to be up-to-date with the state of the projects and the project code base. Besides enabling this option when creating or editing the general settings of the build configuration, you need to include the following sections of code in the web page source:

  • The following code sample in <head> section: <style type="text/css"> @import" <path_to_server>/css/status/externalStatus.css"; </style>

  • Add the following code sample where you want to insert build configuration status display: <script type="text/javascript" src="<path_to_server>/externalStatus.html?js=1&buildTypeId=<buildConfigurationId>" > </script>

  • To provide information on the statuses of builds of several build configurations, repeat the following code in the URL:

    &buildTypeId=<buildConfigurationId>

  • It is also possible to show the status of all build configurations in a project by replacing "&buildTypeId=<buildConfigurationId>" with "&projectId=<projectId>".You can select a combination of these parameters or omit them at all so that all build configurations of all projects are displayed on your web page.

  • You can download the externalStatus.css file and customize its settings (for example, you can disable some columns with display: none; See comments in externalStatus.css)

Build runner

Click this button to open the Build Runners. This button is available on the Create Build Configuration page.

Build configuration steps

This group of buttons appears on the editing build configuration pages.

General Settings

Click this button to define general settings of the build configuration in the Create Edit Build Configuration

Runner: <Build Runner>

Click this button to define the build runner settings in the Build Runners. Contents of the page depends on the selected build runner.

Build Triggering

Click this button to configure the build triggering options in the Build Triggering page.

Artifact Dependencies

Click this button to configure dependencies in the Artifacts Dependencies.

Properties and Environment variables

Click this button to view existing build configuration system properties and environment variables, and define new ones in the Properties and environment variables.

Agent requirements

Click this button to view and manage requirements to the agents, and see the list of agents that meet or do not meet these requirements in the Agent Requirements.

<Build Configuration> Homepage

Click this link to open information page of the build configuration.

Run

Launch build configuration.

Copy

Create a clone of this configuration.

Delete

Delete this configuration and all related information.