GitHub bot for the UWP Community Toolkit project to manage issues and Pull Requests
Перейти к файлу
Nikola Metulev 91342827b3 Create LICENSE 2017-10-16 20:37:29 -07:00
.vscode chore: create azure functions and split code into multiple files 2017-09-29 21:12:05 +02:00
closeInactiveIssues removed mail option 2017-10-16 20:33:22 -07:00
noResponseFromCommunityOnIssues removed mail option 2017-10-16 20:33:22 -07:00
shared feat: add ability to send mails as output of a function 2017-10-07 11:29:37 +02:00
unclosedIssuesInMergedPr removed mail option 2017-10-16 20:33:22 -07:00
.gitignore chore: allow tracking of js files 2017-09-28 20:58:16 +02:00
LICENSE Create LICENSE 2017-10-16 20:37:29 -07:00
index.js chore: create azure functions and split code into multiple files 2017-09-29 21:12:05 +02:00
package-lock.json updated exlusivelabels 2017-10-16 20:13:52 -07:00
package.json updated exlusivelabels 2017-10-16 20:13:52 -07:00
readme.md docs(readme): add docs on functions 2017-10-07 20:37:06 +02:00
tsconfig.json chore: create skeleton of the bot 2017-09-05 13:58:28 +02:00
yarn.lock chore: create azure functions and split code into multiple files 2017-09-29 21:12:05 +02:00

readme.md

GitHub Bot for UWP Toolkit

Bot written in node.js and hosting on Azure Functions to manage issues and Pull Requests of UWP Community Toolkit repository

List of functions

noResponseFromCommunityOnIssues

This function detects issues without response. It automatically send a message to a member of the team.

closeInactiveIssues

This function detects inactive issues (a discussion has already started but no one started to work or closed the issue).

The first time (X days after the last message), an alert/message is sent. The second time, another alert/message is sent. And the third time, the issue is closed

unclosedIssuesInMergedPr

This function listens a GitHub webhook event when a PR is merged. Then, using the pull_request it will detect the linked issues that are not closed and send a message with the id/number of issues left open.

How to use?

  1. First, build the project using tsc command line.
    • Note: if you do not have tsc installed, execute npm install -g typescript
  2. Fill the required environment variables to launch the bot (see next section)
  3. Open the folder related to the function you want to execute
  4. Execute node index command line to start the bot function

Environment variables

These environment variables should be set to launch the bot.

Variable Description
GITHUB_BOT_UWP_TOOLKIT_USERNAME Username of the GitHub account of the bot
GITHUB_BOT_UWP_TOOLKIT_ACCESS_TOKEN Personal Access Token used to retrieve data from the GitHub API
GITHUB_BOT_UWP_TOOLKIT_REPO_OWNER Target Repository owner (should be "Microsoft")
GITHUB_BOT_UWP_TOOLKIT_REPO_NAME Target Repository name (should be "UWP Community Toolkit")
GITHUB_BOT_UWP_TOOLKIT_ACTIVATE_MUTATION Activate GitHub mutation calls (false by default)
NUMBER_OF_DAYS_WITHOUT_ACTIVITY Number of days without activity to check on closeInactiveIssues function (7 days by default)
NUMBER_OF_DAYS_WITHOUT_RESPONSE Number of days without response to check on noResponseFromCommunityOnIssues function (7 days by default)