General Info
Vendor | JetBrains |
License | |
Type | free, open-source |
Plugin Description
Implements several TeamCity extension points with Groovy code. The code can be changed at run-time (by modifying a file under <
TeamCity data directory
>
on the disk). Provides several useful properties out-of-the-box.
Please note that plugin is meant for demonstration purposes and if you plan to use it on a large active TeamCity installation, you should consider implementing the functionality you need in a plain Java plugin.
Installation
- Prior to TeamCity 10.1, put libraries found under the
application_libs
directory (available via the download link below) into theWEB-INF/lib
directory of TeamCity web application. (This step must also be repeated if you reinstall/upgrade TeamCity)Since 10.1, this step is not required as groovy libraries are packed into the plugin zip.
- put the plugin
groovyPlug.zip
into<
TeamCity data directory
>/plugins
- restart the server
- if you edited the scripts earlier and need to use the newly introduced features, rename
<
TeamCity data directory
>/config/_
groovyPlug
_/*.dist
files dropping the.dist
suffix. - It is recommended to ensure you have at least 150m set to
-XX:MaxPermSize
JVM option.
Usage
Edit the files in <
TeamCity data directory
>/config/_
groovyPlug
_
. The changes take effect immediately, no server restart is needed.
The plugin implements the following extension points:
Extension point | Implementation description |
---|---|
| empty demo extension |
| Provides build properties: Starting from 8.1, these properties should be replaced with teamcity.build.triggeredBy /teamcity.build.triggeredBy.username runParam.<name of run parameter> - Beware: this exposes build configuration settings to a user that can run the build (via custom build) |
| To use the feature, add |
| Empty implementation. Allows to perform actions on various build and server events. |
| since TeamCity 5.1 Sample implementation. Allows to add objects to model used within notification templates. |
TeamCity Versions Compatibility
The trunk plugin version should work with the latest TeamCity public build (EAP or release).
There are also branch builds compatible with TeamCity 4.5.x, 5.0.x, 5.1.x, 6.0.x and 6.5.x. See the #Download section.
Since version 8.0, the shared resources functionality is implemented as a separate plugin
Since version 8.1, the information about the user who triggered the build is reported by the TeamCity core. Issue: TW-4502, parameters description
Development links
See Download section for CI builds.
Sources (sources corresponding to the latest TeamCity EAP can be found under trunk
.
Download
From CI server:
trunk compatible with TeamCity 2017.1+
branch compatible with TeamCity 7.x - 10.0
branch compatible with TeamCity 6.5.x
branch compatible with TeamCity 6.0.x
branch compatible with TeamCity 5.0.x
branch compatible with TeamCity 4.x
Related Materials
Issues:
TW-1643
TW-3798
TW-4502
TW-4080
TW-4527
TW-6619
TW-6784