GitHub bot for the UWP Community Toolkit project to manage issues and Pull Requests

Перейти к файлу

Odonno 74fc3b809b merge		2018-03-20 20:48:34 +01:00
.vscode	chore: create azure functions and split code into multiple files	2017-09-29 21:12:05 +02:00
autoLabelPRinProgress	refactor(autoLabelPRinProgress): filter issues if their labels are not updated by the function	2018-02-19 19:50:36 +01:00
inactiveIssues	merge	2018-02-18 17:24:12 +01:00
inactivePRs	feat(inactivePRs): send alert when a PR is inactive	2018-02-18 17:16:53 +01:00
noResponseFromCommunityOnIssues	removed mail option	2017-10-16 20:33:22 -07:00
pendingUservoiceCreation	refactor(pendingUservoiceCreation): use NUMBER_OF_DAYS_WITHOUT_ACTIVITY env variable	2017-10-23 19:46:35 +02:00
shared	merge	2018-03-20 20:48:34 +01:00
tests	merge	2018-03-20 20:48:34 +01:00
unclosedIssuesInMergedPr	feat(autoLabelPRinProgress): automatically add or remove label on issues linked to PR in progress	2018-02-18 23:10:18 +01:00
.gitignore	chore: allow tracking of js files	2017-09-28 20:58:16 +02:00
LICENSE	Create LICENSE	2017-10-16 20:37:44 -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	merge	2018-03-20 20:48:34 +01: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.

inactiveIssues

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

inactivePRs

This function detects inactive Pull Requests.

Send an alert every two weeks to the creator of the PR.

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.

pendingUservoiceCreation

This function detects issues with pending-uservoice-creation label.

autoLabelPRinProgress

This function listens a GitHub webhook event when a PR is created, closed, reopened or merged. Then, it will detect the linked issues to this PR and update the labels of each of these issues by adding/removing the PR in progress label.

How to use?

First, build the project using tsc command line.
- Note: if you do not have tsc installed, execute npm install -g typescript
Fill the required environment variables to launch the bot (see next section)
Open the folder related to the function you want to execute
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 `inactiveIssues` function (7 days by default)
NUMBER_OF_DAYS_WITHOUT_RESPONSE	Number of days without response to check on `noResponseFromCommunityOnIssues` function (7 days by default)