sebbo2002/gitlab-badges

GitLab Badges

镜像概述

这是一个为私有GitLab实例生成SVG徽章的轻量级服务，功能类似shields.io（无网站界面），使用shields.io的gh-badges库生成徽章，可展示项目构建状态、覆盖率等动态信息，适用于私有GitLab环境中需要可视化项目状态的场景。

核心功能与特性

• 徽章生成：支持生成构建状态（build）和覆盖率（coverage）徽章
• 自定义样式：可通过配置指定shields.io风格的徽章样式
• 缓存机制：内置缓存功能，可配置缓存大小提升响应速度
• 轻量部署：支持Docker容器化部署，易于集成到现有环境
• 基础监控：提供/ping接口用于服务可用性检测

使用场景与适用范围

适用于私有GitLab环境，当需要在项目文档、README或内部系统中展示构建状态、代码覆盖率等动态信息时，可替代公共shields.io服务，确保数据隐私和访问控制。

快速开始

直接运行

需提前安装node.js环境：

bash
git clone https://github.com/sebbo2002/gitlab-badges.git
cd ./gitlab-badges
npm install
GITLAB_URL=https://gitlab.example.com GITLAB_TOKEN=* npm start

Docker方式

使用Docker容器运行：

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

配置说明

通过环境变量配置服务参数，支持以下变量：

配置示例

直接运行配置示例

bash
GITLAB_URL=https://gitlab.example.com \
GITLAB_TOKEN=** \
BADGE_STYLE=flat-square \
npm start

Docker运行配置示例

bash
docker run --rm \
  -p 8888 \
  -e 'GITLAB_URL=https://gitlab.example.com' \
  -e 'GITLAB_TOKEN=**' \
  -e 'BADGE_STYLE=flat-square' \
  sebbo2002/gitlab-badges

API接口

/:projectId/:branch/build

生成指定项目、指定分支最新提交的构建状态徽章。项目ID可在GitLab项目设置中获取。

示例：

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

/:projectId/:branch/coverage

生成指定项目、指定分支最新提交的构建覆盖率徽章。项目ID可在GitLab项目设置中获取。

示例：

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

/cache

以JSON格式返回当前所有缓存数据。

/ping

返回pong，用于基础服务监控检测。

待办事项

• 单元测试 🙈
• 代码文档 ✏️