botframework-sdk/dri/issueNotificationBot

Issue Notification Bot

This bot tracks GitHub issues in the Bot Framework repos and sends notifications via Teams to the assignees if:

• Issue is tagged with customer-reported, and:
  • Issue has not been tagged with customer-replied in last 3 business days, or
  • Issue has not been closed in the last 30 days, or
  • Issue has not been closed in the last 90 days

Note: These are based on SLA timelines

It is broken up into two main folders:

1. AzureFunction - This lives in an Azure Function and queries GitHub every half hour
2. Bot - This is the bot. It received data from the Azure Function on /api/data and sends notifications via Teams

Azure Function

Every half hour, the Azure Function queries GitHub for all issues within the Bot Framework. It categorizes them based on tags and whether or not they've been replied to, then sends them to the bot at the /api/data endpoint.

Setup

Rename .env.sample to .env and fill out the following environment variables:

GitHubToken=<Your GitHub Access Token Created in GitHub>

MicrosoftAppId=<AppId of the Bot>
MicrosoftAppPassword=<AppPassword of the Bot>
BotBaseUrl=<https://<myBot>.azurewebsites.net>

UseTestRepo=<true|false - this allows you to create a test repo and fake issues. The bot then changes the expiration time so the issue appears expired>

Run

Run locally via npm run start:local

Deploy

This is easiest to deploy by using the Azure Functions VS Code Extension

Bot

This is a pretty simple, primarily-notifications bot. It listens for the data sent from the Azure Function on /api/data, authenticates the request, processes the data, then sends out notifications to the appropriate users based on issue expiration.

Once installed to a Teams Team/Channel, it queries all members on the Team. For any team members who have not provided their GitHub info to the bot, it sends them a notification message, requesting they log in so that we can notify them.

Setup

Rename appsettings.json.sample to appsettings.json and fill out the following environment variables:

{
  "MicrosoftAppId": "",
  "MicrosoftAppPassword": "",
  "ConnectionName": "<OAuth Connection Name (for GitHub OAuth)>",
  "CosmosDbEndpoint": "",
  "CosmosDbAuthKey": "",
  "CosmosDbDatabaseId": "",
  "CosmosDbContainerId": "",
  "ApplicationInsights": {
    "InstrumentationKey": ""
  },
  "EnableTestMode": "<true|false - this allows you to create a test repo and fake issues. The bot then changes the expiration time so the issue appears expired>"
}

Deploy

Deploy like a standard bot. Be sure to update the Teams App Manifest.

Maintainer

The Bot has some additional commands that it only responds to if they come from the maintainer listed in Bot/Constants.cs > MaintainerGitHubId. Currently, the commands are:

• command:enableNotifications: Send bot error notifications to the Maintainer via Teams.
• command:disableNotifications: Turn off notifications of bot errors.
• command:sendCards: Send test adaptive cards to the maintainer (for testing purposes).
• command:resendGreetings: Query the channel the message comes from for all team members. For any team members who have not provided their GitHub info to the bot, it sends them a notification message, requesting they log in so that we can notify them.

Links

• Bot Web App
• Bot App Service
• Azure Function
• Cosmos Storage