Skip to content

mhick/TfsNotificationRelay

 
 

Repository files navigation

TfsNotificationRelay

TfsNotificationRelay is an extensible plugin for Team Foundation Server that sends notifications to Slack, HipChat and IRC.

Build status

Features

  • Notify multiple targets
  • Rule-based event filtering
  • Collection/project/repository regex filtering
  • Configurable notification format
  • Notification links to event in TFS web
  • Extensible

Events

  • Build completion
  • Build quality change
  • Work item update
  • Team project creation/deletion
  • Git
    • Push
    • Pull request
    • New repository
    • New branch/tag
    • Deleted branch/tag
    • Updated ref
    • Lightweight/annotated tag
    • Force-push
  • TFVC
    • Checkin

Screenshots

Slack screenshot

HipChat screenshot

Installation

Slack

  1. If you don't already have one, add an Incoming WebHooks integration under Configure Integrations in Slack.
  2. Download the latest release or clone and build the source yourself.
  3. Open DevCore.TfsNotificationRelay.dll.config and set at least your full unique Webhook URL in slackWebhookUrl. There are more settings and formats in there that should be somewhat self-explanatory.
  4. Install the plugin by dropping DevCore.TfsNotificationRelay.dll, DevCore.TfsNotificationRelay.Slack.dll, DevCore.TfsNotificationRelay.dll.config and Newtonsoft.Json.dll in C:\Program Files\Microsoft Team Foundation Server 12.0\Application Tier\Web Services\bin\Plugins on the server.

HipChat

  1. Create a room notification token for the HipChat room that you want to send notifications to.
  2. Download the latest release or clone and build the source yourself.
  3. Open DevCore.TfsNotificationRelay.dll.config and set at least roomNotificationToken and the corresponding room setting. There are more settings and formats in there that should be somewhat self-explanatory.
  4. Install the plugin by dropping DevCore.TfsNotificationRelay.dll, DevCore.TfsNotificationRelay.HipChat.dll, DevCore.TfsNotificationRelay.dll.config and Newtonsoft.Json.dll in C:\Program Files\Microsoft Team Foundation Server 12.0\Application Tier\Web Services\bin\Plugins on the server.

IRC

See TfsBot.

Configuration

See the wiki for more information.

Extending TfsNotificationRelay

TfsNotificationRelay can easily be extended to send notifications to other services. Notifier modules referenced in the configuration file will be loaded dynamically at run time, so TfsNotificationRelay doesn't have to be recompiled.

  1. Start a new class library project.
  2. Add a reference to DevCore.TfsNotificationRelay.dll.
  3. Create a class that implements the single method in INotifier. Take a look at the SlackNotifier class for pointers.
  4. Build and drop in your new dll in the Plugins directory on the server.
  5. Add a new bot element in DevCore.TfsNotificationRelay.dll.config with the correct assembly-qualified type name and settings.

TFS version support

There are two separate releases of TfsNotificationRelay:

  • TfsNotificationRelay for TFS 2013 - Should work on TFS 2013.2 and up. Because of a few breaking API changes in TFS 2013.2, the plugin won't work on previous versions without some minor modifications.
  • TfsNotificationRelay for TFS 2015

Branches

Branch Description
master TfsNotificationRelay for TFS 2013
tfs2015 TfsNotificationRelay for TFS 2015

License

Copyright (C) 2014-2015 Kristian Adrup

TfsNotificationRelay is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See included file COPYING for details.

About

An extensible plugin for TFS 2013/2015 that sends notifications to Slack, HipChat and IRC

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%