Redmine GitHub钩子

这个插件允许你在GitHub上推送更改时更新Redmine中的本地Git仓库。

项目状态：正在寻找维护者

这个项目目前没有积极开发，尽管我会继续为现有用户提供支持，但你可以通过加入团队来改变这一状况。

如果你使用这个项目并希望进一步开发它，请在寻找维护者的工单上介绍自己。

描述

Redmine长期以来一直支持Git仓库，允许你直接在Redmine中浏览代码和查看变更集。为此，Redmine依赖于Git仓库的本地克隆。

如果你的共享仓库在远程机器上 - 例如在GitHub上 - 这不幸意味着需要做一些工作来保持本地、Redmine可访问的仓库是最新的。常见的方法是设置一个定时任务，定期拉取任何更改并更新Redmine。

这种方法完全可行，但有点笨重和繁琐。Redmine GitHub钩子插件允许GitHub在仓库有更改被推送时通知你的Redmine安装，只有在实际需要时才触发本地仓库和Redmine数据的更新。

入门

1. 安装插件

将gem添加到你的Gemfile.local中： gem "redmine_github_hook"
bundle
运行迁移：bundle exec rake redmine:plugins:migrate RAILS_ENV=production
重启你的Redmine

2. 将仓库添加到Redmine

将Git仓库添加到项目中（注意，无论你是否想使用Redmine GitHub钩子，这都应该有效）。

只需按照保持Git仓库同步的说明操作。

你不需要像Redmine说明中描述的那样设置定时任务。

3. 将GitHub连接到Redmine

在GitHub上进入仓库设置界面。
在"Webhooks & Services"下添加一个新的"WebHook"。"Payload URL"需要采用以下格式：[redmine_url]/github_hook（例如http://redmine.example.com/github_hook）。
- 默认情况下，GitHub钩子假设你的GitHub仓库名称与Redmine安装中的项目标识符相同。
  - 如果不是这种情况，你可以在Post-Receive URL中使用格式[redmine_url]/github_hook?project_id=[identifier]（例如http://redmine.example.com/github_hook?project_id=my_project）来指定实际的Redmine项目标识符。
  - GitHub钩子随后将更新指定项目中的所有仓库。请注意，如果你的项目中有许多仓库，这个过程可能需要一段时间。
  - 如果你希望GitHub钩子只更新当前仓库，你可以在Post-Receive URL中使用格式[redmine_url]/github_hook?project_id=[identifier]&repository_id=[repository]（例如http://redmine.example.com/github_hook?project_id=my_project&repository_id=my_repo）来指定额外的参数。
- 在大多数情况下，只让"push"事件触发webhook就足够了，但你可以根据需要自定义事件。
- 注意：确保你添加的是Webhook - 这是Redmine Github钩子所期望的。GitHub有一些内置的Redmine集成；那不是你要找的。

就这样。现在，每当更改被推送到GitHub时，GitHub将向Redmine GitHub钩子插件发送HTTP POST。然后插件负责将更改拉取到本地仓库并用它们更新Redmine数据库。

假设

Redmine运行在类Unix系统上。2.0版本之前的Redmine应使用redmine_1.x分支。据报告，这个gem可以与Redmine 5.x、4.x、3.x、2.x版本一起使用。
命令行上可用Git 1.5或更高版本。

故障排除

检查你的日志文件

如果遇到问题，你的Redmine日志文件可能包含一些有价值的信息。需要检查两件事：

对/github_hook的POST请求是否在日志文件中出现？如果出现，结果状态码是什么？
如果用于拉取更改的git命令因任何原因失败，日志文件中应该也有一些关于失败的详细信息。

日志文件通常位于你的Redmine目录的log/production.log中，尽管你的Web服务器日志可能包含一些额外的线索。

权限问题

关于权限，无论Redmine以什么用户身份运行，都需要权限执行以下操作：

从GitHub上的远程仓库读取
读取和写入Redmine服务器上的本地仓库

你以什么用户身份运行Redmine取决于你的系统和你如何设置Redmine安装。

GitHub

这意味着你需要在GitHub上添加其SSH密钥。如果该用户还没有SSH密钥，生成一个并将公共SSH密钥作为部署密钥添加到GitHub上的仓库（或者如果你更喜欢的话，作为你自己的密钥之一）。

本地仓库

运行Redmine的用户需要权限读取和写入服务器上的本地仓库。

发生了什么

以下序列图概述了过程中不同部分之间的交互：

sequenceDiagram
    participant Dev as 开发机器
    participant GH as GitHub
    participant Rm as Redmine
    Dev->>GH: git push
    GH->>Rm: POST /github_hook
    Rm->>GH: git fetch
    GH-->>Rm: commits
    Rm->>Rm: 更新仓库