Skip to content

Latest commit

 

History

History
51 lines (27 loc) · 2.84 KB

README.md

File metadata and controls

51 lines (27 loc) · 2.84 KB

TeamCity Symphony Notifier

A configurable TeamCity plugin that notifies your symphony channel.

screenshot

Because it is a TeamCity Custom Notifier plugin, it extends the existing user interface and allows for easy configuration directly within your TeamCity server. Once installed, you can configure the plugin for multiple TeamCity projects and multiple build conditions (i.e. Build failures, successes, hangs, etc.)

Installation

  1. Download the plugin zip package.

  2. Follow the TeamCity plugin installation directions.

Admin Configuration

  • In order for notifications to work, we need give TeamCity our bot and pod details.

Admin Menu

  1. Choose "Symphony Notifier" from the Administration Menu in TeamCity.

Bot Details

  1. Enter the bot details. Usually, you will only need to enter the common name, email and the private key of your bot. However, some environments additionally require the use of bot certificates. Add these in if needed.

Enter Endpoint Details

  1. Set the Endpoint Details. You will need to provide URLs for the various endpoints of symphony. Examples are given, it's usually only necessary to change the host part of the URL to your pod. However, in some corporate environments, you may need a proxy to access symphony, or you might be running the agent or keymanager on an internal URL. Enter these here.

  2. Save the Page. Your connection details will be tested.

  3. Trust Manager Details. If your organisation is running with some bizarre certificates for symphony, you can enter these in the box provided, to allow TeamCity to trust the Symphony servers. This probably won't be used very often.

  4. Templates: You can supply your own FreeMarker template here, which you can design in MessageML using The Renderer Tool. Leave the box blank to use the default.

User Configuration

Notifier Details

Once you have configured the bot, you need to set up the notifier for your user. Go to "My Settings And Tools" -> Notification Rules, and you should see the Symphony Notifier listed.

You will need to supply your stream ID. You can get this by:

  1. Create a new room or chat with the TeamCity Bot (you set up in the admin details, above)
  2. Send a message in the room
  3. Click on the time of the message to pop up the below window:

Stream Id

  1. Copy the "Conversation ID" out of this field, and place into the TeamCity configuration screen.