Workrbot – Microsoft TFS Auto Moderator

I use Microsoft TFS on a daily basis and have found that no matter how many documents and guides you write regarding processes people will log bugs/user stories incorrectly. To try and help with this I built a bot which can be given a ruleset and notify users when substandard work items are added. More information can be found on my github page here. Below you can find the installation instructions.

Installation

Workrbot can be installed within IIS and requires an Active Directory user account to run. The below steps show a basic installation.

Create new IIS Application Pool

Open IIS and create a new application pool for Workrbot, once created open ‘Advanced Settings’ for the pool and turn on ‘Load User Profile’

IIS Application pool

Create new IIS Application

This is where Workrbot will be accessed and is where you will need to deploy to. The settings are fairly straight forward for this (remember to select the application pool you created)
add iis application

Create Active Directory User Account

Workrbot requires an AD user account to run, no specific permissions are required so just add a basic account.

Add AD User

Grant User Permissions Within TFS

In order to update work items within TFS Workrbot needs some permissions, I have just added it to the Team I want to manage.

Add User to TFS

Deploy to IIS

Deploy Workrbot to your IIS application in your preferred way. I normally do it from visual studio and publish it to the directory of the application however you can do it using web deploy or any other means of getting it to your application.

Configure Workrbot Settings

You should now have a site you can access (assuming you deployed to IIS correctly). Simply navigate to your workrbot instance using your preferred browser and click settings.
workrbot settings

Configure TFS Web Hooks

In order for TFS to communicate with Workrbot you need to setup web hooks within TFS (This can be done by hovering over the TFS configureation cog and selecting service hooks). You will then need to add the following web hooks.
– Work Item Created (Point to http://youriisinstance/workrbot/api/TFS/WorkItemCreated/)
– Work Item Deleted (Point to http://youriisinstance/workrbot/api/TFS/WorkItemDeleted/)
– Work Item Restored (Point to http://youriisinstance/workrbot/api/TFS/WorkItemRestored/)
– Work Item Updated (Point to http://youriisinstance/workrbot/api/TFS/WorkItemUpdated/)
– Work Item Commented On (Point to http://youriisinstance/workrbot/api/TFS/CommentPosted/)

When adding the web hook you will need to set Resource Version to latest. Don’t worry if you test the web hook and it fails (some aren’t coded to accept the fake request that is sent when testing). Once all setup you should have something that looks like this
hooks

Configure Workrbot

You are almost done! Now just access your Workrbot instance and setup rules to do whatever you want
events

Leave a Reply

Your email address will not be published.

This site uses Akismet to reduce spam. Learn how your comment data is processed.