root

README

Mattermost Azure DevOps Plugin

Table of Contents

• License
• Overview
• Features
• Installation
• Setup
• Connecting to Azure DevOps
• Development

License

See the LICENSE file for license rights and limitations.

Overview

This plugin integrates the services of Azure DevOps in Mattermost. For a stable production release, please download the latest version from the Github Releases and follow the instructions to install and configure the plugin.

Features

This plugin contains the following features:

• Right-hand sidebar (RHS) shows the list of linked projects and subscriptions created for each project with separate buttons to connect an account, link or unlink a project and add or delete a subscription.

• Preview work item: A preview of the work item will be created when a work item URL is posted in a channel and the user is connected to his Azure DevOps account.

• OAuth: A user can connect or disconnect to their Azure DevOps account using the slash command below or clicking on the "Connect Your Account" button in RHS.

  - /azuredevops connect
  - /azuredevops disconnect
  

• Link projects: A user can link a project existing on Azure DevOps using the slash command below or clicking on the "Link new project" button in RHS.

  - /azuredevops link [project link]
  

• Unlink projects: A user can unlink a project appearing in the RHS under "Linked Projects" by clicking on the unlink-icon button.

• Create work items: A work item can be created using the slash command below.

  - /azuredevops boards create
  

  On successful creation of a work item, you will get a message from the bot with the details of the newly created work item.

• Add subscriptions: A user can create subscriptions for a linked project to get messages in a selected channel for selected events on work items like Create, Update and Delete. To add a new subscription for a linked project click on the project title under "Linked Projects" in RHS then click on the "Add new subscription" button in the subscription view. Users can also create subscriptions using the slash command below.

  - /azuredevops boards subscribe
  

• View/List subscriptions: A user can view the list of subscriptions for a project by going on the subscriptions list page after clicking on the project title under "Linked Projects". Users can also view the list of all subscriptions for a channel by using the below slash command in the channel.

  - /azuredevops boards subscriptions
  

• Delete subscriptions: A user can delete subscriptions for a project from RHS by going on the subscriptions list page after clicking on the project title under "Linked Projects". Users can also delete a subscription for a project by using the slash command below.

  - /azuredevops boards unsubscribe [subscription id]
  

Installation

1. Go to the releases page of this GitHub repository and download the latest release for your Mattermost server.
2. Upload this file to the Mattermost System Console > Plugins > Management page to install the plugin. To learn more about how to upload a plugin, see the documentation.
3. Enable the plugin from System Console > Plugins > Mattermost Azure Devops plugin.

Setup

• Developer setup
• OAuth app registration for Azure DevOps
• Plugin Setup

Connecting to Azure Devops

• Enter slash command /azuredevops connect.
• You will get a response with a link to connect your Azure DevOps account.
• Click on that link. If it asks for a login, enter your credentials and connect to your account.

After connecting successfully, you will get a direct message from the Azure DevOps bot containing a Welcome message and some useful information.

Note: You will only get a direct message from the bot if your Mattermost server is configured to allow direct messages between any users on the server. If your server is configured to allow direct messages only between two users of the same team, then you will not get any direct messages.

Documentation

Index

• Variables

Variables

var Manifest model.Manifest