github/rally

GitHub Rally Probot 镜像文档

镜像概述

GitHub Rally Probot是一个基于Probot框架开发的工具，旨在实现GitHub与Rally之间的无缝交互。它作为桥梁连接GitHub的代码仓库活动与Rally的项目管理功能，帮助团队实现开发流程与项目跟踪的集成。

核心功能和特性

• 跨平台集成：建立GitHub与Rally之间的通信通道，实现两个平台的数据交互
• 事件驱动机制：响应GitHub事件（如提交、PR操作、Issue变更等）并同步至Rally
• Probot框架支持：基于GitHub官方Probot框架开发，兼容Probot生态系统的标准功能
• 可配置化交互：支持通过环境变量和配置文件自定义同步规则和行为逻辑

使用场景和适用范围

• 开发团队需要将GitHub上的开发活动（代码提交、问题解决、PR状态）自动同步到Rally进行项目进度跟踪
• 项目管理者希望在Rally中实时查看与GitHub仓库关联的任务状态和开发进度
• 需要实现Rally任务分配或状态变更向GitHub的反馈，构建双向工作流管理体系

使用方法和配置说明

前提条件

• 拥有GitHub账号及目标仓库的管理权限
• 拥有Rally账号及API访问权限
• 已安装Docker环境（Docker 19.03+推荐）

部署示例

Docker Run命令

bash
docker run -d \
  --name rally-probot \
  -e GITHUB_APP_ID=<your-github-app-id> \
  -e PRIVATE_KEY_PATH=/app/private-key.pem \
  -e RALLY_API_KEY=<your-rally-api-key> \
  -e RALLY_WORKSPACE=<your-rally-workspace> \
  -v /local/path/to/private-key.pem:/app/private-key.pem \
  docker.xuanyuan.run/github/rally

Docker Compose配置

yaml
version: '3'
services:
  rally-probot:
    image: docker.xuanyuan.run/github/rally
    container_name: rally-probot
    environment:
      - GITHUB_APP_ID=<your-github-app-id>
      - PRIVATE_KEY_PATH=/app/private-key.pem
      - RALLY_API_KEY=<your-rally-api-key>
      - RALLY_WORKSPACE=<your-rally-workspace>
      - RALLY_PROJECT=MyProject  # 可选，指定Rally项目
      - LOG_LEVEL=info  # 可选，日志级别：debug/info/warn/error
    volumes:
      - /local/path/to/private-key.pem:/app/private-key.pem
    restart: unless-stopped

配置参数说明

详细配置步骤

1. 创建GitHub App：

   • 访问GitHub -> Settings -> Developer settings -> GitHub Apps，注册新Probot应用
   • 记录生成的App ID，下载私钥文件（.pem格式）
   • 配置应用权限（如issues:write、pull_requests:read等）和事件订阅

2. 获取Rally凭证：

   • 登录Rally账户，进入个人设置 -> API Keys生成API密钥
   • 确认Rally工作区名称或ID（可在Rally工作区设置中查看）

3. 启动与验证：

   • 将GitHub私钥文件挂载到容器内指定路径
   • 使用上述部署命令启动容器，替换所有<占位符>为实际值
   • 在GitHub执行触发事件（如创建Issue），检查Rally对应工作区是否生成同步记录

参考链接

• 官方GitHub仓库：https://github.com/github/rally
• Probot框架文档：https://probot.github.io/docs/
• Rally API文档：[***]