Buildviz 开源项目教程

Buildviz 开源项目教程

buildvizTransparency for your build pipeline's results and runtime项目地址:https://gitcode.com/gh_mirrors/bu/buildviz

1. 项目介绍

Buildviz 是一个开源项目，旨在为你的构建管道提供透明度，展示构建结果和运行时间。它通过可视化构建历史和测试结果，帮助开发团队更好地理解和优化他们的构建流程。Buildviz 支持多种 CI/CD 系统，如 Concourse、GoCD、Jenkins 和 TeamCity，并且可以通过自定义方式集成其他系统。

2. 项目快速启动

2.1 安装 Buildviz

首先，从 GitHub 下载 Buildviz 的最新版本：

$ curl -OL https://github.com/cburgmer/buildviz/releases/download/0.15.1/buildviz-0.15.1-standalone.jar

2.2 启动 Buildviz 服务

使用 Java 运行下载的 JAR 文件：

$ java -jar buildviz-0.15.1-standalone.jar

Buildviz 服务启动后，默认会在 http://localhost:3000 上运行。

2.3 导入构建数据

你可以通过 POST 请求将构建数据发送到 /builds 端点。例如：

$ curl -v -H "Content-type: application/json" -d@- 'http://localhost:3000/builds' <<EOF
[
  {
    "jobName": "my job",
    "buildId": "42",
    "start": 1451449853542,
    "end": 1451449870555,
    "outcome": "pass",
    "inputs": [
      {
        "revision": "1eadcdd4d35f9a",
        "sourceId": "git@github.com:cburgmer/buildviz.git"
      }
    ],
    "triggeredBy": [
      {
        "jobName": "Test",
        "buildId": "42"
      }
    ],
    "testResults": [
      {
        "name": "Test Suite",
        "children": [
          {
            "classname": "some class",
            "name": "A Test",
            "runtime": 2,
            "status": "pass"
          }
        ]
      }
    ]
  }
]
EOF

3. 应用案例和最佳实践

3.1 从支持的构建服务器同步数据

Buildviz 可以通过 build-facts 工具从支持的 CI/CD 系统（如 Jenkins）中提取构建数据。首先，下载并运行 build-facts：

$ curl -LO https://github.com/cburgmer/build-facts/releases/download/0.5.4/build-facts-0.5.4-standalone.jar
$ java -jar build-facts-0.5.4-standalone.jar jenkins

3.2 自定义数据导入

如果你使用的是非支持的 CI/CD 系统，可以通过自定义方式将构建数据 POST 到 /builds 端点。

4. 典型生态项目

4.1 Build-facts

build-facts 是一个与 Buildviz 配合使用的工具，用于从支持的 CI/CD 系统中提取构建数据。它支持 Jenkins、Concourse、GoCD 和 TeamCity 等系统。

4.2 JUnit XML 格式

Buildviz 支持 JUnit XML 格式的测试结果，可以通过 PUT 请求将测试结果上传到 Buildviz。

通过以上步骤，你可以快速启动并使用 Buildviz 来可视化你的构建管道，优化构建流程。

buildvizTransparency for your build pipeline's results and runtime项目地址:https://gitcode.com/gh_mirrors/bu/buildviz