This server acts like a very tiny shields.io to generate SVG badges for your private GitLab instance. Uses shield.io's gh-badges to generate them.
npm i -g @sebbo2002/gitlab-badges
gitlab-badges
# OR
docker run -e GITLAB_URL=https://gitlab.example.com -e GITLAB_TOKEN=**** sebbo2002/gitlab-badges
Use environment variables to set login credentials and pushover tokens:
GITLAB_URL | GitLab URL (https://gitlab.example.com) |
---|---|
GITLAB_TOKEN | A private Token which is used to query the GitLab API |
PORT | Port to listen to, default to 8888 |
BADGE_STYLE | Optional, allows to specify the used [badge style](http://shields.io/#styles) |
MAX_CACHE_SIZE | Optional, to setup the living cache size, defaults to 50 |
Generates a badge with the current build state of the latest commit in the given branch. You'll find your project's ID in the GitLab project settings.
https://gitlab-badges.example.com/1337/master/build
Generates a badge with the current build coverage of the latest commit in the given branch. You'll find your project's ID in the GitLab project settings.
https://gitlab-badges.example.com/1337/master/coverage
Returns all currently cached data as a JSON object.
Returns pong
. Usually helpful to monitor the server in a very basic way.
Copyright (c) Sebastian Pekarek under the MIT license.