Service for managing comments on GitHub

Go to file

Jakub Sokołowski 1f92b0f8f3 fix whitespace breaking the table Signed-off-by: Jakub Sokołowski <jakub@status.im>		2018-12-12 23:24:36 +01:00
src	fix whitespace breaking the table	2018-12-12 23:24:36 +01:00
.babelrc	add initial package.json .gitignire and .babelrc	2018-12-12 15:57:17 +01:00
.gitignore	add initial package.json .gitignire and .babelrc	2018-12-12 15:57:17 +01:00
README.md	add platform section	2018-12-12 16:11:30 +01:00
gulpfile.js	add basic app sources and gulpfile.js	2018-12-12 16:22:15 +01:00
package.json	add templating using nunjucks	2018-12-12 23:21:47 +01:00

README.md

Description

This is a minimal REST API intended for use with a Continuous Integration system for managing comments on GitHub.

The problem this solves is posting comments in a PR from multiple builds without spamming the comment section. Instead we post just one comment with a table and continue to update it.

Example Comment

Jenkins Builds

Status	Commit	Platform	Build	Duration	Result
❌	5b1b9e9f	`android-e2e`	PR-7056#3	~6 min	📄 build log
✔️	5b1b9e9f	`macos`	PR-7056#3	~13 min	📦 macos package

❌	9e9528f	`android-e2e`	PR-7056#4	~7 min	📄 build log
✔️	9e9528f	`macos`	PR-7056#4	~14 min	📦 macos package

API

It exposes just 1 call:

PUT /comment/:id - Post a comment for PR with given ID.

By default it listens on localhost:8080.

Configuration

There are few environment variables you can set:

LISTEN_PORT - Default: 8000

Usage

For development use:

npm run start

For building use:

npm run build

To create the docker image use:

npm run image

To push the image use:

npm run push