Upgrading DSL

These types of settings changes do not require changing the Kotlin DSL as the changes are applied by the server automatically on each settings regeneration from the DSL.
It is recommended though to update the DSL to a newer configs version to reduce performance hit and make Kotlin scripts closer to the settings you see in the UI.

A lot of changes in TeamCity settings fall into this category. For example, some plugin implementing a build step may rename its parameters.
The DSL from the previous TeamCity version generates a parameter with the old name, but TeamCity can automatically replace the old parameter name with the new one after DSL execution.

Some TeamCity settings changes require external information and cannot be performed automatically. For example, in TeamCity 10.0 the settings of the cloud integration were stored in a dedicated file which was not committed to a VCS. In TeamCity 2017.1, these settings were moved to the project level. TeamCity cannot perform such a transformation of settings automatically without external data, so manual DSL code update is required.

This is the version specified in settings.kts, it looks like this:

version = "2025.03"

TeamCity uses this version to perform transformations after DSL execution to make resulting XML configuration files up-to-date with the current TeamCity version where they will be applied. For instance, your DSL scripts could be generated by TeamCity 2017.2 and have the version set to 2017.2. When you upgrade your server to version 2022.04, TeamCity will execute your DSL and apply additional transformations to modify the settings according to the format expected by the newest version.

The DSL code generated by TeamCity before 2022.04 has the DSL API version encoded into the package name, for example: jetbrains.buildServer.configs.kotlin.v2019_2. The v2019_2 part there corresponds to the TeamCity version when this DSL API was introduced.

The new DSL API version is introduced when there are significant incompatible changes in DSL API. However, after TeamCity 2019.2 there were no incompatible changes. So several TeamCity versions after that still used the same v2019_2 package names for the newly generated DSL code. Because of the lack of incompatible changes starting with TeamCity 2022.04 the DSL API version is considered redundant, and it is recommended to perform a switch to packages without this version.

The settings.kts contains a so-called configs version:

version = "2025.03"

This version should be changed to the current version of the TeamCity server. For instance, if TeamCity server was upgraded to 2025.03, then 2025.03 should be specified in the settings.kts.

But before doing so, you should first review the health reports produced by your TeamCity server after it applied the most recent changes in your DSL scripts. These health reports describe what changes should be done to your DSL before you could safely change configs version.

If you see a message like:

Please change the configs version to "%product-version%" in projects:
<the list of projects>

then no additional changes to your DSL are required and you can change the config's version to 2025.03. Otherwise, you will receive the following message:

DSL scripts should be updated to produce settings for version %product-version%:
change DSL for build configurations:
<affected build configurations>
to update DSL, do the following:
<description of what should be changed>

You should review these suggestions and apply them to your DSL scripts. The configs version can be changed only after all these suggestions are applied.

Starting with TeamCity 2022.04 it is recommended to remove the version part of the imports in your DSL code to make the DSL code look simpler and improve code completion suggestions in IntelliJ IDEA.

For example, the imports:

import jetbrains.buildServer.configs.kotlin.v2019_2.*
import jetbrains.buildServer.configs.kotlin.v2019_2.projectFeatures.*

can be changed to:

import jetbrains.buildServer.configs.kotlin.*
import jetbrains.buildServer.configs.kotlin.projectFeatures.*

To remove the DSL API version from the imported package names, the following should be done:

1. Update <dependencies/> section of the pom.xml file

   The artifactId configs-dsl-kotlin should be changed to configs-dsl-kotlin-latest and configs-dsl-kotlin-plugins should be changed to configs-dsl-kotlin-plugins-latest

   In the end <dependencies/> section should look like:

<dependencies>
    <dependency>
        <groupId>org.jetbrains.teamcity</groupId>
        <artifactId>configs-dsl-kotlin-latest</artifactId>
        <version>${teamcity.dsl.version}</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.jetbrains.teamcity</groupId>
        <artifactId>configs-dsl-kotlin-plugins-latest</artifactId>
        <version>1.0-SNAPSHOT</version>
        <type>pom</type>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-stdlib-jdk8</artifactId>
        <version>${kotlin.version}</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-script-runtime</artifactId>
        <version>${kotlin.version}</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

2. Make sure TeamCity server is up and running.

   The artifact with id configs-dsl-kotlin-plugins-latest is provided by the TeamCity server. This is the same TeamCity server which is specified in the <repositories/> section of the pom.xml with id teamcity-server. Maven should be able to download the artifact configs-dsl-kotlin-plugins-latest, hence this server should be up and running.

3. Change imports in all the Kotlin files.

   The version part of the package name should be removed in all the Kotlin files, for instance:

   import jetbrains.buildServer.configs.kotlin.v2019_2.*

   should be replaced with:

   import jetbrains.buildServer.configs.kotlin.*

4. Compile DSL and generate settings.

   After the changes to pom.xml and Kotlin files, it is recommended to run mvn teamcity-configs:generate task to ensure that the project still compiles. If there are no errors, then these changes can be checked into the versioned settings repository.

Parameters of the ReportTab project features should be changed:

• The revisionRuleRevision parameter should be removed if the value of the revisionRuleName parameter is set to lastFinished, lastSuccessful, or lastPinned.

• The revisionRuleRevision parameter should be renamed to revisionRuleBuildNumber if the parameter revisionRuleName has the buildNumber value.

• The revisionRuleRevision parameter should be renamed to revisionRuleBuildTag and suffix .tcbuildtag should be removed from the parameter's value if the parameter revisionRuleName has the value buildTag.

Since TeamCity 2019.2, use the DslContext.baseDir property to access a file under the .teamcity directory from DSL scripts. For example:

val dataFile = File(DslContext.baseDir, "data/setup.xml")

This is required because TeamCity 2019.2 no longer guarantees that the current working directory for DSL scripts is the .teamcity directory.

The DSL producing Maven build steps should be updated. If a Maven build step did not have the useOwnLocalRepo parameter set to true, the following localRepoScope parameter should be added:

maven {
   ...
   localRepoScope = MavenBuildStep.RepositoryScope.MAVEN_DEFAULT
}

If useOwnLocalRepo was set to true, then it should be replaced with:

maven {
   ...
   localRepoScope = MavenBuildStep.RepositoryScope.BUILD_CONFIGURATION
}

If MSBuild or VS.Solution build steps have the parameter toolsVersion set to MSBuildStep.MSBuildToolsVersion.V15_0, the additional version = MSBuildStep.MSBuildVersion.V15_0 parameter should be added:

msBuild {
    ...
    toolsVersion = MSBuildStep.MSBuildToolsVersion.V15_0
    version = MSBuildStep.MSBuildVersion.V15_0
}

The build configuration version control settings parameter buildDefaultBranch is deprecated: branchFilter should be used instead.
For instance, if buildDefaultBranch was set to false, the following branch filter should be specified instead:

vcs {
   branchFilter = """
      +:*
      -:<default>
   """
}

If you used Kotlin DSL with TeamCity 2017.2 for Docker plugin configurations, you may need to perform some changes in your Kotlin configuration scripts to make your code compatible with TeamCity 2018.1.

The essence of the changes:

• build step dockerBuild is now converted to dockerCommand

• the parameters for DockerBuild are now sub-parameter for commandType selector

Note the difference:

Docker Build 2 Docker Command migration

# DockerBuild in 2017.2:
dockerBuild {
    name = "name of the build step"
    source = content {
        content = """
            FROM busybox

            MAINTAINER KIR <kir@maxkir.com>
        """.trimIndent()
    }
    namesAndTags = "maxkir/maxkir_test"
}
#----------------------------------------
# DockerBuild in 2018.1:
dockerCommand {
    name = "name of the build step"
    commandType = build {
        source = content {
            content = """
                FROM busybox

                MAINTAINER KIR <kir@maxkir.com>
            """.trimIndent()
        }
        namesAndTags = "maxkir/maxkir_test"
    }
}

dockerCommand {
    name = "name of the push step"
    commandType = push {
        namesAndTags = "maxkir/maxkir_test"
    }
}

Since TeamCity 2018.1 Gerrit publisher settings in the Commit Status Publisher build feature allow customising the Gerrit label that reflects the build status, i.e. now you can use something other than Verified.

To manually modify Kotlin DSL settings, the label = "Verified" statement must be added as follows:

features {
    ...
    commitStatusPublisher {
        publisher = gerrit {
            server = "<server>"
            gerritProject = "<project>"
            failureVote = "-1"
            successVote = "+1"
            userName = "<user>"
            uploadedKey = "<key>"
            label = "Verified"  // the statement to be added
        }
     }
    ...
}

This release introduces the new DSL API version, v2017_2. The previous API version works and you can keep using it if you do not need the features provided by the new API.

note

To get sample DSL code for the newly supported features without switching a project to the Kotlin format, use the Download settings in Kotlin format action on the project administration page.

If you used 2017.2 EAPs and tested changing DSL settings via the UI, you need to apply all the UI patches created by TeamCity before upgrading as some API is changed in an incompatible way.

The current package name for the settings generated by TeamCity is jetbrains.buildServer.configs.kotlin.v2017_2.

With the new API, you can benefit from a number of new features, including the editable administration UI for Kotlin DSL projects and DSL documentation. To use them for your existing project, your .kt files should be switched to packages from the v2017_2 version.

• To compile this project, you also need to update your pom.xml. The easiest way is to invoke the Download settings in Kotlin format action in your project and copy the pom.xml from the generated zip archive. Alternatively you can update pom.xml yourself with the following:

  • change teamcity.dsl.version to: <teamcity.dsl.version>2017.2</teamcity.dsl.version>

  • change the kotlin version to: <kotlin.version>1.1.4-3</kotlin.version> and add a dependency on kotlin\-runtime and kotlin\-reflect:

<dependency>
  <groupId>org.jetbrains.kotlin</groupId>
  <artifactId>kotlin-runtime</artifactId>
  <version>${kotlin.version}</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.jetbrains.kotlin</groupId>
  <artifactId>kotlin-reflect</artifactId>
  <version>${kotlin.version}</version>
  <scope>compile</scope>
</dependency>

Once you switch the project to new API and check in the changes, TeamCity will detect and apply them and after that web UI editing will be enabled.
To use the new DSL API in a repository with an existing pom.xml, the maven dependency version has to be updated to 2017.2.

If you used Kotlin DSL with TeamCity 2017.1 for Docker plugin configurations, you may need to perform some changes in your kotlin configuration scripts to make your code compatible with TeamCity 2017.2. Basically, TeamCity provides a converter for Kotlin configuration scripts to perform those changes automatically, but if it does not work due to some reason, the following changes need to be made manually:

• rename the build runner step with the Docker Build runType to DockerBuild

• rename the build runner step with the Docker Compose runType to DockerCompose

• rename the docker-compose.file build parameter to dockerCompose.file

Starting from TeamCity 2017.2, the Docker plugin has its own typed DSL for the Docker Registry Connections build feature, Container Wrapper, Docker, and Docker Compose runners.

Docker Compose and Docker Build

steps {
    dockerCompose {
        name = "Start services"
        file = "db-tests/scripts/docker-compose.yml"
    }

    dockerBuild {
        name = "Docker build step"
        source = path {
            path = "some/context/Dockerfile"
        }

        // Case for Dockerfile specified by an URL:
        //source = url {
        //    url = "https://raw.githubusercontent.com/JetBrains/teamcity-docker-minimal-agent/master/ubuntu/Dockerfile"
        //}

        // Case for Dockerfile specified by text:
        //source = content {
        //    content = """
        //        FROM busybox
        //        MAINTAINER Kirill Maximov <kir@jetbrains.com>
        //    """.trimIndent()
        //}

        contextDir = "some/context"
        namesAndTags = "my:tag"
    }
}

Docker Build Feature

features {
    dockerSupport {
        cleanupPushedImages = true
        loginToRegistry = on {
            dockerRegistryId = "PROJECT_EXT_2"
        }
    }
}

Command Line runner with Container Wrapper

script {
    scriptContent = "ls -lR"
    dockerImage = "openjdk:8u121"
    dockerPull = true
    dockerRunParameters = "--rm -v /some/path:/another/path:ro"
}

Since 2017.2 EAP3, TeamCity supports default templates in projects. This setting was stored in a project feature of the "DefaultTemplate" type in EAP3 and EAP4, but since 2017.2 RC the project configuration schema was changed to accommodate for default templates.
To manually convert a DSL project configuration that employs the default template, you will have to delete a corresponding project feature and replace it with the defaultTemplate property assignment as follows:

2017.2 EAP3/4 DSL project configuration with a default template configured:

object Project : Project({
    uuid = "2b241ffb-9019-4e60-9a3a-d5475ab1f312"
    extId = "ExampleProject"
    parentId = "_Root"
    name = "Example Project"
    ...
    features {
        ...
        feature {
            id = "PROJECT_EXT_4"
            type = "DefaultTemplate"
            param("template", "ExampleProject_MyDefaultTemplate")
        }
        ...
    }
    ...
})

2017.2 DSL project configuration with the default template configured:

object Project : Project({
    uuid = "2b241ffb-9019-4e60-9a3a-d5475ab1f312"
    extId = "ExampleProject"
    parentId = "_Root"
    name = "Example Project"
    defaultTemplate = "ExampleProject_MyDefaultTemplate"
    ...
    features {
        ...
    }
    ...
})

Since 2017.2, TeamCity had been bundling the .NET CLI plugin (now reintroduced as the .NET runner). If you were using Kotlin DSL for the plugin parameters in TeamCity 2017.1.x, you need to change the commands as follows. In TeamCity 2017.1.x:

steps {
    step {
        type = "dotnet"
        param("dotnet-command", "build")
        param("dotnet-paths", "WindowsAzure.sln")
    }
}

Since TeamCity 2017.2, you can explicitly specify build steps with parameters:

steps {
    dotnetBuild {
        projects = "WindowsAzure.sln"
    }
}

These changes should be performed before enabling versioned settings in the projects where they were disabled on TeamCity upgrade with the message: "Versioned settings are disabled in this project because its settings files were modified during TeamCity upgrade".

The changes in this section should be done to Kotlin scripts on changing the scripts config version from 10.0 to 2017.1

param("dotNetCoverage.tool", "dotcover")
param("dotNetCoverage.dotCover.home.path", "%\teamcity.tool.JetBrains.dotCover.CommandLineTools.bundled%")

param("dotNetCoverage.tool", "dotcover")
param("dotNetCoverage.dotCover.home.path", "/custom/path")

edition = PowerShellStep.Edition.Desktop

param("jetbrains_powershell_edition", "Desktop")