/teamcity-build-scan-plugin

TeamCity plugin that integrates with the Gradle Build Scan Service.

Primary LanguageJavaApache License 2.0Apache-2.0

teamcity-build-scan-plugin

TeamCity plugin that integrates with build scans, the free service offered by Gradle Inc.

For each Gradle build that is run from TeamCity, this plugin exposes the link to the created build scan in the TeamCity UI.

Version compatibility

This plugin requires that you use at least build scan plugin 1.8 in your Gradle builds. It is recommended that you use the very latest build scan plugin version at all times to get the most insights from your builds.

TeamCity build runner requirements

When not using TeamCity's GradleRunner to launch Gradle builds, use the TeamCity build scan Gradle plugin to notify TeamCity about the scans that were published while running a build. If you use the GradleRunner to launch Gradle builds, there is no need to apply that TeamCity build scan Gradle plugin.

Installation

  1. Download the plugin .zip file from https://bintray.com/etienne/teamcity-plugins/teamcity-build-scan-plugin (see Downloads section at the bottom of the page).

  2. Go to the plugin list of your TeamCity installation at <TeamCityInstanceRootUrl>/admin/admin.html?item=plugins and click on the link Upload plugin zip to install the previously downloaded plugin .zip file.

  3. Restart TeamCity.

  4. Trigger your Gradle builds with build scans enabled.

  5. Find the links of the published build scans in the Overview section of each TeamCity build.

Slack Integration

  1. In Slack, create a webhook and keep track of the created URL.

  2. In TeamCity, on the build configuration for which you want to be notified about published build scans, create a configuration parameter with name BUILD_SCAN_SLACK_WEBHOOK_URL and the value being the URL of the webhook created in step #1.

  3. Trigger your Gradle builds with build scans enabled.

  4. Find a notification about the published build scans in the Slack channel configured in the webhook.

Feedback and Contributions

Both feedback and contributions are very welcome.

Acknowledgements

License

This plugin is available under the Apache License, Version 2.0.

(c) by Etienne Studer