how to use this plugin

[shawnxue]

Hi,

I am newbie for this plugin. Is there any wiki or documents on how to use this plugin to run a build in team city?

Thanks

Shawn

[jonnyzzz]

Unfortunately, not. You're very welcome to provide some documentation based on your try.

The plugin itself does the following

• it reports build agent configuration parameter docker and vagrant with version of docker / vagrant it detected on build agent host
• it provides the build runner where you can select either docker or vagrant to make it running your script.

Note, the build runner mounts build checkout director into the container/vm and executes your script there preserving build working directory path. The runner does nothing to pass any build environment variables inside (e.g. BUILD_NUMBER or any other).

In the build script one may use TeamCity %references% to any parameters you have in the build. This makes it quite easy to pass all necessary parameters from a build agent to a container/vm that is started.

Plugin does not cover any cleanup tasks. So your build agent machine should be configures to clean older vagrant/docker images from a build agent machine to avoid out of disk space issues