marcells/node-build-monitor

node-build-monitor### 概述和主要用途node-build-monitor是一个用Node.js编写的构建监控工具，支持多种主流构建服务。它可轻松扩展以支持新服务，允许混合使用不同服务，并通过响应式、可主题化的Web前端自动显示最新构建状态。该工具专为Docker容器化运行设计，便于部署和管理。### 核心功能和特性-** 多服务支持 **：兼容Travis CI、Jenkins、TeamCity、Azure DevOps等多种构建服务

-** 可扩展性 ：易于扩展以支持新的构建服务 - 服务混合 ：允许同时监控来自不同服务的构建 - 响应式Web前端 ：自动显示最新构建状态，支持主题定制 - Docker友好 **：专为Docker容器化运行设计，部署简单### 支持的服务- Travis CI

• Jenkins
• TeamCity
• Azure DevOps和Team Foundation Server构建
• Azure DevOps和Team Foundation Server发布
• Team Foundation Server 2013及更低版本（通过tfs-proxy）
• Team Foundation Server 2015/2017（本地部署）
• GitLab（本地部署，测试版）
• BuddyBuild
• Bamboo
• BambooDeploy
• Bitbucket Pipelines
• Buildkite
• Bitrise
• CCTray
• Shippable
• PRTG
• Circle CI
• Drone### 使用场景和适用范围适用于需要集中监控多个项目、多种构建服务构建状态的开发团队和DevOps工程师。可用于开发环境、CI/CD流水线监控，或作为团队仪表板展示构建状态，帮助快速发现构建失败和异常。### 使用方法和配置说明#### 快速启动选项有四种运行方式：1.** 下载独立版本运行 ：最简单的运行方式 2. 使用Node.js手动运行 ：开发时首选 3. 使用Docker Compose运行 ：生产环境首选 4. 在Kubernetes中作为Helm Chart运行**#### 配置文件构建监控配置可放置在以下位置之一：1. %HomeDirectory%/node-build-monitor-config.json

2. %PathOfExecutable%/config.json（仅独立版本）
3. app/config.json

配置文件示例：

json
{
  "monitor": {
    "interval": 30000,
    "numberOfBuilds": 12,
    "latestBuildOnly": false,
    "sortOrder": "date",
    "errorsFirst": false,
    "expandEnvironmentVariables": false,
    "debug": true
  },
  "services": [
    {
      "name": "Travis",
      "configuration": {
        "slug": "node-build-monitor"
      }
    },
    {
      "name": "Travis",
      "configuration": {
        "slug": "marcells/bloggy",
        "latestBuildOnly": true
      }
    }
  ]
}

监控设置（monitor部分）| 设置项 | 描述 |

|--------|------| | interval | 更新间隔（毫秒） | | numberOfBuilds | 显示的构建数量（若latestBuildOnly启用则忽略） | | latestBuildOnly | 仅获取每个服务配置的最新构建，可在服务配置中覆盖 | | sortOrder | 构建排序方式，选项：project（按项目）、date（按日期） | | errorsFirst | 错误构建优先显示，之后应用sortOrder | | expandEnvironmentVariables | 从环境变量扩展服务配置属性（如${MY_PASSWORD}读取环境变量MY_PASSWORD） | | debug | 启用/禁用控制台调试输出 |

服务配置（services部分）services是一个数组，每个元素描述一个构建服务配置，可混合不同服务。每个服务配置包含：- name：服务名称（如"Travis"、"Jenkins"）

• configuration：服务特定配置（因服务而异）

Travis CI```json

{ "name": "Travis", "configuration": { "slug": "marcells/node-build-monitor" } }

|--------|------|
| `slug` | 构建名称（通常为GitHub用户名和项目名） |
| `url` | Travis CI服务器地址，默认为`travis-ci.org` |
| `token` | Travis访问令牌（用于私有构建） |
| `is_enterprise` | 是否为Travis CI企业版，默认为`false` |

##### Jenkins```json
{
  "name": "Jenkins",
  "configuration": {
    "url": "http://jenkins-server:8080",
    "username": "jenkins_username",
    "password": "jenkins_password",
    "job": "JenkinsJobName",
    "numberOfBuildsPerJob": 3,
    "options": {
      "strictSSL": false
    }
  }
}
```| 设置项 | 描述 |
|--------|------|
| `url` | Jenkins服务器URL |
| `username` | Jenkins用户名 |
| `password` | Jenkins密码 |
| `job` | 单任务模式下的Jenkins任务名称（若与`view`同时存在则优先） |
| `view` | 单视图模式下的Jenkins视图名称（可选） |
| `options` | 请求选项，参考https://github.com/request/request#requestdefaultsoptions |
| `numberOfBuildsPerJob` | 每个任务获取的最大构建数（可选，默认无限制） |

##### TeamCity```json
{
  "name": "TeamCity",
  "configuration": {
    "url": "http://teamcity_username:teamcity_password@teamcity-server:8111",
    "buildConfigurationId": "TeamCityProject_TeamCityBuildConfiguration",
    "branch": "master",
    "authentication": "ntlm",
    "username": "teamcity_username",
    "password": "teamcity_password",
    "useGuest": true,
    "reportFailedToStart": true
  }
}
```| 设置项 | 描述 |
|--------|------|
| `url` | TeamCity服务器URL（含凭据，无尾随反斜杠） |
| `buildConfigurationId` | TeamCity构建配置ID |
| `branch` | 要监控的分支名称，未指定则监控所有分支 |
| `authentication` | 认证方式（仅`ntlm`需要） |
| `username` | TeamCity用户名（如需） |
| `password` | TeamCity密码（如需） |
| `useGuest` | 使用访客用户（如需） |
| `reportFailedToStart` | 将"启动失败"构建报告为构建失败 |

##### Azure DevOps和Team Foundation Server构建```json
{
  "name": "Tfs",
  "configuration": {
    "url": "https://{youraccount}.visualstudio.com or http://tfs-server:8080/tfs",
    "collection": "DefaultCollection",
    "project": "projectname",
    "username": "username",
    "pat": "personalaccesstoken",
    "queryparams": "&branchName=refs/heads/master&definitions=4,5,6,7&maxBuildsPerDefinition=1",
    "includeQueued": false,
    "showBuildStep": false
  }
}
```| 设置项 | 描述 |
|--------|------|
| `url` | Azure DevOps账户URL（`https://dev.azure.com/youraccount/`）或TFS服务器URL（`http://tfs-server:8080/tfs`） |
| `collection` | 集合名称，默认为`DefaultCollection` |
| `project` | 团队项目ID或名称 |
| `username` | 登录用户名（域用户需转义反斜杠：`"domain\\username"`） |
| `pat` | 具有构建访问权限的个人访问令牌（TFS 2015用户可使用密码） |
| `queryparams` | REST API接受的查询参数，参考Azure DevOps Build API |
| `includeQueued` | 是否显示排队构建，默认为`false` |
| `showBuildStep` | 是否显示当前构建步骤/阶段，默认为`false` |

#### Docker部署示例（Docker Compose）```yaml
version: '3'
services:
  node-build-monitor:
    image: docker.xuanyuan.run/marcells/node-build-monitor
    ports:
      - "3000:3000"
    volumes:
      - ./config.json:/app/config.json
    restart: always

运行命令：docker-compose up -d

访问Web前端：http://localhost:3000

确保当前目录下存在config.json文件，包含正确的监控和服务配置。