Skip to content
main
Switch branches/tags
Code

Latest commit

It appears the teamcity-rest-client versioning got reset in ~2017, and the version currently used is the highest number, but is actually quite old.
It has been updated to be 1.14.0.
This upgrade brings in many up-issues to its dependencies which may resolve some outstanding issues around TLSV2.
40fbe43

Git stats

Files

Permalink
Failed to load latest commit information.

This plug-in allows TeamCity builds to trigger deployments in Octopus Deploy.

Get the plugin

Download the plugin from the Octopus Deploy downloads page or the JetBrains plugins downloads.

Installation and usage instructions are available in the Octopus Deploy documentation.

Building

To build the plugin from code:

  1. Install the latest version of the JDK
  2. Install TeamCity
  3. Run gradlew -Dteamcity.distribution=C:\TeamCity clean diztZip (set the TeamCity directory to the location where you extracted or installed TeamCity locally). The gradlew script will download Gradle for you if it is not already installed.
  4. The plugin is available at build/distributions/Octopus.TeamCity.zip

Editing and debugging in IntelliJ

  1. Install TeamCity locally to C:\TeamCity. Allow the service to start for the first time, and add an admin user. Then stop the service so it is not running.
  2. Give yourself full permissions to the Teamcity Data folder (usually C:\ProgramData\JetBrains\TeamCity). This folder may be hidden.
  3. Import the Gradle project into IntelliJ.
  4. Create a Tomcat Configuration:
    1. Click Run -> Edit Configurations.
    2. Click the plus button and select Tomcat -> Local Run Configuration - Startup
    3. Click the Configure... button next to the Application Server: option.
    4. Set the Tomcat Home option to the location of your TeamCity installation (probably C:\TeamCity). Run Configuration - Startup
    5. Click the OK button.
  5. Under the Startup/Connection tab, set the Startup script to C:\TeamCity\bin\teamcity-server.bat run and the Shutdown script to C:\TeamCity\bin\teamcity-server.bat stop. Do this for both the Run and Debug environments.
  6. Ensure that the Before launch list includes the step Run Gradle Task 'diztZip'.
  7. Run the copy-plugin.cmd script as an external tool after the Gradle task. This will copy the plugin to TeamCity.
  8. Ignore the Warning: No artifacts configured message. Run Configuration - Startup
  9. Click the OK button to save your changes.

At this point you can run TeamCity from IntelliJ. If need be you can run TeamCity in debug mode and step through the plugin code as it is executed by TeamCity.

Updating the version of Octopus CLI we embed

If the Octopus CLI has changed such that we need to update the version we embed with the plugin the steps are as follows:

  • Locate the build in TeamCity and navigate to the Artifacts tab
  • Expand the OctopusTools.Zips.version.zip file
  • Download octo.exe from the OctopusTools.version.zip file. Also download the OctopusTools.version.portable.zip file Artifacts
  • Rename the latter to OctopusTools.portable.zip and then copy them into the \octopus-agent\src\main\resources\resources\3\0 folder, over the existing files

Publishing a new version to the JetBrains Marketplace

Currently we manually publish new versions of the TeamCity plugin directly in the JetBrains Marketplace due to the lack of support for specifying release notes as part of publishing via cUrl or gradle, once they've added support for this we will automate this part of the process.

  1. Tag master with the next major.minor.patch version and wait for the tag to be built by TeamCity
  2. Download the Octopus.TeamCity.zip artifact from the TeamCity Plugin build Download artifact from TeamCity
  3. Login to the JetBrains Marketplace using the "Jetbrains account" credentials from the password manager.
  4. Click the Edit button in the top right corner Edit plugin
  5. Choose the artifact that you downloaded from TeamCity
  6. Leave the Channel as Stable
  7. Enter the release notes for the version of the plugin that your creating. Note: The Change Notes field does not support Markdown it only supports Html.
  8. Click Upload new build to publish the new version of the TeamCity plugin

About

JetBrains TeamCity plugin to trigger releases on build completion

Resources

License

Packages

No packages published

Languages