TEAMCITY KOTLIN DSL HOW TO
TEAMCITY KOTLIN DSL CODE
TEAMCITY KOTLIN DSL SERIES

First, create a new project in TeamCity by pointing to a repository URL. It is best to add a Kotlin DSL configuration to an existing project in TeamCity. The goal of this post is to demonstrate an approach for building an existing application with Kotlin DSL. Spring Petclinic is a Java project that uses Maven for the build. In this tutorial, we are going to use the famous spring-petclinic project for demonstration. Creating build configurations dynamically.Finally, we will take a look at advanced topics such as extending the DSL. We will then dive into the practicalities of using Kotlin DSL for build configurations.

TEAMCITY KOTLIN DSL HOW TO

We will start with the basics on how to get started with configuration-as-code in TeamCity.

TEAMCITY KOTLIN DSL SERIES

In this series of posts, we are going to explain how to use Kotlin to define build configurations for TeamCity. In TeamCity 2018.x Kotlin support was greatly improved for a more pleasant user experience. The possibility to use Kotlin for defining build configurations was added in TeamCity 10. In TeamCity, we can use Kotlin DSL to author build configurations.

TEAMCITY KOTLIN DSL CODE

Some users may also prefer code to configuring the builds with point-and-click via UI. The benefits of this approach include versioning support via VCS repository, a simplified audit of the configuration changes, and improved portability of the configurations. Use this method only if the recommended approach lacks flexibility for your purposes.Configuration as code is a well-established practice for CI Servers.

This means that your DSL code won't be available when a user clicks the 'View as code' button or when an initial commit is performed when enabling versioned settings in a project. Note that TeamCity will not be able to generate DSL code using the syntax provided by your extension if you employ this approach it will generate standard Kotlin DSL code instead.

For this, add a *.jar file with your code to the same kotlin-dsl directory. If your plugin implements a major addition to the TeamCity functionality and requires an arbitrary DSL extension that cannot be expressed using the recommended approach, you have an option to write a completely custom extension. This is a recommended approach which covers most use cases and can be properly processed by TeamCity. Refer to the sections below for more information on expected syntax.Įach extension must be described in its own *.xml file inside the kotlin-dsl directory. Inside the kotlin-dsl directory, create an *.xml file and describe a specific extension. Inside the plugin's ZIP package, create the kotlin-dsl directory. With extensions, you can create a custom class library for your plugin, and TeamCity will handle the DSL generation and conversion when the plugin functionality is used in DSL-based projects. Typed parameters for each specific functionality Ĭontrolled validation and proper compilation ĭSL extensions are natively mapped onto the UI settings and displayed in the 'View DSL' mode Īfter each UI change, versioned settings are updated using the plugin-specific DSL syntax. This provides the following benefits for DSL-based projects: Extensions define a plugin-specific DSL syntax for settings (for example, of a build runner or a project feature implemented by the plugin). TeamCity allows writing custom Kotlin DSL extensions for plugins.

Teamcity kotlin dsl