TeamCity 3.0 Help

1.General Settings

Administration > project > build configuration > General Settings

The General Settings Page in Version 3.0

Item

Description

Name

Edit the name of the build configuration. The build configuration name should not contain special characters.

Description

Enter an optional description.

Build options

Specify behavior of the builds of this build configuration. The possible options are:

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

  • Fail build if at least one test failed: Check this option to mark the build as failed, if the build fails at least one test. If this option is not checked, the build can be marked successful even if it fails to pass a number of 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 deal with builds that hang and maintains agent efficiency.

  • Number of simultaneously running builds: Specify the number of builds of the same configuration that can run simultaneously on all agents. This option helps avoid the situation, when all of the agents are busy with the builds of a single project.

Build numbering format

Specify the Build Numbering format. 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 version control systems for each project, there could be {build.vcs. number. 2} etc, depending on the number of source control systems used by the project.

Build counter

Specify the counter to be used in the build numbering. Each build increases the build counter by 1.

Reset 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 the status of the latest build to an external web page. See Enabling the Status Widget for Build Configurations.

The General Settings Page in Version 3.1

Item

Description

Name

Edit the name of the build configuration. The build configuration name should not contain special characters.

Description

Enter an optional description.

Build number format

Specify the Build Numbering format. 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 version control systems for each project, there could be {build.vcs. number. 2} etc, depending on the number of source control systems used by the project.

Build counter

Specify the counter to be used in the build numbering. Each build increases the build counter by 1.

Reset counter

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

Artifact paths

Use this field to specify directories containing artifacts or file names as a comma-separated string. If a directory is specified its contents will be uploaded to the server.

Fail build if

Specify how TeamCity should fail builds. The possible options are:

  • build process exit code is not zero: Check this option to mark the build as failed if the build process doesn't exit successfully.

  • at least one test failed: Check this option to mark the build as failed if the build fails at least one test. If this option is not checked, the build can be marked successful even if it fails to pass a number of tests.

  • an error message is logged by build runner: Check this option to mark the build as failed if the build runner reports an error while building.

  • it runs longer than ... minutes: Check this option and enter a value in minutes to enable time control on the build. If the specified amount of time is exceeded, the build is automatically canceled. This option helps to deal with builds that hang and maintains agent efficiency.

Build options

Specify additional options for the builds of this build configuration. The possible options are:

  • Enable status widget: Check this option to enable retrieving the status of the latest build to an external web page. See Enabling the Status Widget for Build Configurations.

  • Limit the number of simultaneously running builds: Specify the number of builds of the same configuration that can run simultaneously on all agents. This option helps avoid the situation, when all of the agents are busy with the builds of a single project. Enter 0 to allow an unlimited number of builds to run simultaneously.

Last modified: 20 April 2023