Bors-NG 开源项目教程

Bors-NG 开源项目教程

bors-ng 👁 A merge bot for GitHub Pull Requests 项目地址: https://gitcode.com/gh_mirrors/bo/bors-ng

1. 项目介绍

Bors-NG 是一个用于 GitHub Pull Requests 的合并机器人。它实现了一个持续测试的工作流程，确保主分支永远不会被破坏。Bors-NG 集成了 GitHub Pull Requests 和 CI/CD 工具（如 GitHub Actions），确保在合并之前所有更改都经过测试。

Bors-NG 的主要功能包括：

• 自动将 Pull Requests 合并到主分支之前进行测试。
• 支持批量测试，减少测试次数。
• 如果测试失败，支持二分查找（bisecting）以快速定位问题。
• 提供一个仪表盘，方便监控合并队列的状态。

2. 项目快速启动

2.1 安装 Bors-NG

首先，确保你已经安装了 Docker。然后，你可以通过以下命令启动 Bors-NG：

docker run -d -p 4000:4000 --name bors-ng borsng/bors-ng

2.2 配置 Bors-NG

在 GitHub 上添加 Bors-NG 应用到你的仓库。然后，在你的仓库中创建一个 bors.toml 文件，内容如下：

status = ["ci"]

2.3 设置 GitHub Actions

在你的 GitHub Actions 工作流中添加一个步骤，用于触发 Bors-NG 的测试。例如：

name: CI
on: [push, pull_request]
jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Run tests
        run: |
          # 你的测试命令

2.4 使用 Bors-NG

在 Pull Request 中，当你认为代码已经准备好合并时，可以在评论中输入以下命令：

bors r+

Bors-NG 将会自动将该 Pull Request 添加到合并队列中，并进行测试。

3. 应用案例和最佳实践

3.1 应用案例

Bors-NG 广泛应用于需要高稳定性的项目中，例如大型开源项目和企业的核心代码库。通过 Bors-NG，这些项目可以确保主分支始终处于可发布状态，避免因合并冲突或测试失败导致的发布延迟。

3.2 最佳实践

• 批量测试：合理配置 Bors-NG 的批量测试策略，减少不必要的测试次数。
• 二分查找：利用 Bors-NG 的二分查找功能，快速定位导致测试失败的 Pull Request。
• 仪表盘监控：定期查看 Bors-NG 的仪表盘，了解合并队列的状态，及时处理问题。

4. 典型生态项目

Bors-NG 通常与以下项目一起使用，以构建完整的 CI/CD 流程：

• GitHub Actions：用于运行测试和构建流程。
• Docker：用于容器化部署 Bors-NG。
• PostgreSQL：Bors-NG 默认使用 PostgreSQL 作为数据库。

通过这些生态项目的配合，Bors-NG 可以实现高效的代码合并和测试流程，确保项目的稳定性和可靠性。

bors-ng 👁 A merge bot for GitHub Pull Requests 项目地址: https://gitcode.com/gh_mirrors/bo/bors-ng