如何5分钟快速部署Bulldozer：GitHub自动化合并工具

【免费下载链接】bulldozer GitHub Pull Request Auto-Merge Bot 项目地址: https://gitcode.com/gh_mirrors/bu/bulldozer

Bulldozer是一款强大的GitHub自动化合并工具，能够在所有必要的状态检查成功且获得所需审核后自动合并拉取请求（PR）。它可以显著提升开发团队的工作效率，尤其适合CI构建时间较长或需要频繁合并代码的项目。

🌟 为什么选择Bulldozer？

Bulldozer作为一款高效的GitHub自动化合并工具，具有以下核心优势：

• 自动合并：当所有必需的状态检查通过且获得必要审核时，自动合并PR
• 智能触发：可通过标签、评论或特定分支等条件触发合并
• 分支更新：自动将目标分支的更新合并到PR分支，保持代码同步
• 灵活配置：支持多种合并策略和自定义规则，满足不同团队需求

📋 准备工作

在开始部署Bulldozer之前，请确保您已准备好以下环境和资源：

• 一台运行Linux的服务器（推荐）
• Docker环境（用于快速部署）
• GitHub账号及管理员权限（用于创建GitHub App）
• 网络连接（用于拉取Docker镜像和连接GitHub）

🚀 步骤1：获取Bulldozer代码

首先，克隆Bulldozer项目仓库到本地：

git clone https://gitcode.com/gh_mirrors/bu/bulldozer
cd bulldozer

⚙️ 步骤2：配置Bulldozer

Bulldozer需要一个配置文件来定义其行为。我们可以从示例配置文件开始：

cp config/bulldozer.example.yml config/bulldozer.yml

然后根据您的需求编辑配置文件。主要配置项包括GitHub App信息、服务器端口和合并规则等。详细的配置说明可以参考项目的config/bulldozer.example.yml文件。

🔧 步骤3：创建GitHub App

要让Bulldozer与GitHub交互，需要创建一个GitHub App：

1. 登录GitHub，进入Settings > Developer settings > GitHub Apps
2. 点击"New GitHub App"，填写以下信息：
   • Webhook URL: http(s)://<your-bulldozer-domain>/api/github/hook
   • Webhook secret: 生成一个随机字符串，需与配置文件中的github.app.webhook_secret一致
3. 设置权限：
   • 仓库管理：只读
   • 检查：只读
   • 仓库内容：读写
   • 问题：读写
   • 仓库元数据：只读
   • 拉取请求：读写
   • 提交状态：只读
4. 订阅事件：
   • Check run
   • Commit comment
   • Pull request
   • Status
   • Push
   • Issue comment
   • Pull request review
   • Pull request review comment

创建完成后，记录App ID和私钥，这些将用于配置文件。

🐳 步骤4：使用Docker部署

Bulldozer提供了Docker镜像，使部署过程变得简单：

# 构建Docker镜像
./godelw docker build --verbose

# 运行Docker容器
docker run --rm -v "$(pwd)/config:/secrets/" -p 8080:8080 palantirtechnologies/bulldozer:latest

这条命令会启动Bulldozer服务器，并将本地的config目录挂载到容器中，同时将容器的8080端口映射到主机的8080端口。

✅ 步骤5：验证部署

部署完成后，可以通过访问http://localhost:8080/health来检查服务是否正常运行。如果返回健康状态，说明Bulldozer已成功部署。

接下来，在GitHub上安装您创建的App到目标仓库，并添加一个.bulldozer.yml文件到仓库根目录。您可以参考config/examples/standard.bulldozer.v1.yml作为配置示例。

🎯 快速配置示例

以下是一个简单的.bulldozer.yml配置示例，实现了基本的自动合并功能：

version: 1
merge:
  trigger:
    labels: ["merge when ready"]
  ignore:
    labels: ["do not merge"]
  method: squash
  delete_after_merge: true

这个配置表示：当PR被添加"merge when ready"标签且没有"do not merge"标签时，使用 squash 方式合并，并在合并后删除分支。

📚 进阶使用

Bulldozer还支持许多高级功能，如：

• 远程配置：可以从其他仓库引用配置文件
• 合并策略：根据不同条件使用不同的合并方法
• 状态检查：添加额外的状态检查要求

详细的配置选项可以在项目的README.md中找到，您可以根据团队需求进行定制。

🛠️ 故障排除

如果遇到部署问题，可以检查以下几点：

1. 确保GitHub App的Webhook URL和密钥配置正确
2. 检查服务器是否可以访问GitHub API
3. 查看Bulldozer日志，获取详细错误信息
4. 确认配置文件格式正确，没有语法错误

通过以上步骤，您应该能够在5分钟内成功部署Bulldozer，开始享受自动化合并带来的便利。Bulldozer将帮助您的团队减少手动操作，提高开发效率，让开发者更专注于代码编写而非合并流程。

【免费下载链接】bulldozer GitHub Pull Request Auto-Merge Bot 项目地址: https://gitcode.com/gh_mirrors/bu/bulldozer