epages/circle-ci-wall

镜像概述

epages/circle-ci-wall是一个集成CircleCI和GitHub API的Docker镜像，旨在通过Web界面展示CI/CD构建状态墙，帮助团队直观监控项目的构建进度与结果。

核心功能

• 连接CircleCI API获取项目构建数据
• 集成GitHub API获取仓库信息
• 提供Web界面展示构建状态墙
• 支持Docker Compose一键部署
• 依赖Redis存储数据

使用场景

• 团队内部CI/CD状态监控
• 办公环境大屏展示构建进度
• 项目构建状态实时追踪

配置说明

前提条件

1. 获取CircleCI个人API Token：CircleCI API设置
2. 获取GitHub个人API Token：https://github.com/settings/tokens

Docker Compose部署示例

创建docker-compose.yml文件：

yml
metricio:
  container_name: circle-ci-wall-metricio
  image: epages/circle-ci-wall:latest
  links:
    - "redis:redis"
  ports:
    - "8009:3000"
  restart: "always"
  environment:
    REDIS_SERVER_HOST: "redis"
    CIRCLE_CI_TOKEN: $CIRCLE_CI_TOKEN
    GITHUB_USER: $GITHUB_USER
    GITHUB_TOKEN: $GITHUB_TOKEN

redis:
  container_name: circle-ci-wall-redis
  image: redis:latest
  restart: "always"

执行部署命令：

sh
export CIRCLE_CI_TOKEN=<你的CircleCI Token>
export GITHUB_USER=<你的GitHub用户名>
export GITHUB_TOKEN=<你的GitHub Token>
docker-compose up -d

本地开发步骤

1. 克隆仓库：git clone https://github.com/depoulo/Circle-CI-Wall.git && cd Circle-CI-Wall
2. 安装依赖：npm install
3. 设置环境变量：

   sh
   export CIRCLE_CI_TOKEN=<你的CircleCI Token>
   export GITHUB_USER=<你的GitHub用户名>
   export GITHUB_TOKEN=<你的GitHub Token>
   

4. 启动服务：npm start
5. 访问地址：http://localhost:3000

贡献指南

1. Fork项目仓库
2. 进行代码修改
3. 执行代码检查：npm run lint
4. 运行测试：npm test
5. 推送修改到你的仓库
6. 提交Pull Request

许可证

基于MIT许可证分发。