@sebbo2002/gitlab-badges

It's like a very tiny shields.io (without website) for your private GitLab instance…

Usage no npm install needed!

<script type="module">
  import sebbo2002GitlabBadges from 'https://cdn.skypack.dev/@sebbo2002/gitlab-badges';
</script>

README

GitLab Badges

License

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.

📦 Installation

npm i -g @sebbo2002/gitlab-badges
gitlab-badges

# OR

docker run -e GITLAB_URL=https://gitlab.example.com -e GITLAB_TOKEN=**** sebbo2002/gitlab-badges

🔧 Configuration

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

📑 API

/:projectId/:branch/build

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.

Example
https://gitlab-badges.example.com/1337/master/build

/:projectId/:branch/coverage

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.

Example
https://gitlab-badges.example.com/1337/master/coverage

/cache

Returns all currently cached data as a JSON object.

/ping

Returns pong. Usually helpful to monitor the server in a very basic way.

🙆🏼‍♂️ Copyright and license

Copyright (c) Sebastian Pekarek under the MIT license.