1.8 KiB
1.8 KiB
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 | Build | Duration | Result |
|---|---|---|---|---|
| ❌ | 5b1b9e9f | prs/android-e2e/PR-7056#3 | ~6 min | 📄 build log |
| ✔️ | 5b1b9e9f | prs/macos/PR-7056#3 | ~13 min | 📦 macos package |
| ❌ | 9e9528f | prs/android-e2e/PR-7056#4 | ~7 min | 📄 build log |
| ✔️ | 9e9528f | prs/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