Expose TeamCity build properties dictionary via TeamCityBuildInfo

[augustoproiete]

Edit: Instead of parsing the .properties file, we'll parse the .properties.xml file instead implemented by @BlythMeister in #3113

---

TeamCity provides additional information about the build and the build agent through a text file that is written during the build.

This file contains a number of properties about the build that are not available via environment variables such as configuration parameters.

The location of the file is available during the build in the environment variable TEAMCITY_BUILD_PROPERTIES_FILE and looks something like C:\agentName\t\buildTmp\teamcity.build1035226021699882408.properties.

The file uses the java.util.Properties format (a.k.a. "Property Resource Bundles") and looks like this:

#TeamCity build properties without 'system.' prefix
#Fri Dec 03 19:52:06 AST 2020
agent.home.dir=C\:\\TeamCity\\buildAgent02
agent.name=DEV-TC-42
agent.ownPort=8082
agent.work.dir=C\:\\agent42\\w
build.number=v5.2.4-dev
java.io.tmpdir=C\:\\agent42\\t\\buildTmp
teamcity.agent.cpuBenchmark=489
teamcity.agent.dotnet.agent_url=http\://localhost\:8082/RPC2
teamcity.agent.dotnet.build_id=186380
teamcity.auth.password=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
teamcity.auth.userId=TeamCityBuildId\=186380
teamcity.build.changedFiles.file=C\:\\agent42\\t\\buildTmp\\changedFiles7806694707471261708.txt
teamcity.build.checkoutDir=C\:\\agent42\\w\\fd0d02f87a570f9d
teamcity.build.id=186380

I suggest exposing these properties via a name/value collection that returns the value of a property by its name (or null if name does not exist).

e.g.

var buildId = TeamCity.Build.Properties["teamcity.build.id"]; // 186380
var configSetting = TeamCity.Build.Properties["configSetting"]; // null

---

The workaround today is to read the TEAMCITY_BUILD_PROPERTIES_FILE environment variable from the Cake script and parse the file yourself, thus exposing these properties via TeamCityBuildInfo is for convenience.

[augustoproiete]

Instead of parsing the .properties file, we'll parse the .properties.xml file instead implemented by @BlythMeister in #3113

[cake-build-bot]

🎉 This issue has been resolved in version v1.1.0 🎉

The release is available on:

• GitHub Release
• NuGet Package
• Chocolatey Package
• .Net Global Tool

Your GitReleaseManager bot 📦🚀