Skip to content

xebialabs-community/teamcity-xldeploy-plugin

Repository files navigation

TeamCity / XL Deploy plugin

Build Status Build Status Build Status License: MIT Github All Releases

Installation

  1. Generate zip file using mvn package from root directory
  2. Copy zip file to TeamCity Data Directory (e.g. ~/.BuildServer/plugins)
  3. Restart TeamCity server
  4. Configure build steps

Package step

  • XL Deploy host, XL Deploy port, XL Deploy username, XL Deploy password are for future use.
  • Deployable and Templates should be in XML format.
  • All artifacts described in the Deployables XML with file="pathTo/filename" should be listed under Artifact locations. The format is pathTo=PathInWorkspace, one per line. Here, pathTo is the path relative to the DAR root and does not include the filename. It is typically the same as the Artifact name. PathInWorkspace is the path to the artifact in the TeamCity build workspace and includes the filename.
  • Application dependencies should be listed in the format AppName=1.0 or AppName=[1.0,2.0), one per line.
  • Bound templates shoudl be listed in the format /TemplateName, one per line. The name should correspond to the name used in the XML under Templates.
  • Orchestrators should be listed by name (e.g. parallel-by-container), one per line.
  • The DAR package will be %teamcity.build.workingDir%/%teamcity.build.id%/deploymentPackage/ApplicationName-VersionName.dar.

screenshot of publish step screenshot of publish step

Publish step

  • If the DAR package is built in the XldPackage step, use %teamcity.build.workingDir%/%teamcity.build.id%/deploymentPackage/MyDemoApp-%build.number%.dar for its path.

screenshot of publish step

Deploy step

  • Specify Application Name, Version Name, and Enviroment Id.
  • For XL Deploy 8.6.x and higher, use plugin version 1.3.0. This version performs the validate call for the deployment.
  • For XL Deploy 8.5.x and lower, use plugin version 1.2.6. This version omits the validate call for the deployment.

screenshot of deploy step

Build parameters

screenshot of deploy step

Tested on TeamCity 2018.1.3.