Mantis Source Integration 使用与安装指南

1. 安装指南

兼容性

Source Integration 插件遵循 语义版本控制。主版本的递增表示所需的最小 MantisBT 版本的改变。

根据您使用的 MantisBT 版本，请确保获取适当的源代码版本。使用 发布标签 或插件 GitHub 仓库的相关分支。

安装步骤

1. 下载适当的版本（请参阅上面的 兼容性部分），或者克隆 源代码 并检出正确的分支。

2. 将主 Source 插件（Source/ 目录）复制到您的 Mantis 安装目录下的 plugins/ 目录中。

3. 将所有剩余的插件，或仅适用于您的仓库的插件，复制到您的 Mantis 安装目录下的 plugins/ 目录中。

4. 以管理员身份登录到您的 Mantis 安装，然后导航到 '管理' -> "管理插件"。

5. 在 "可用插件" 列表中，您将找到 "Source Control Integration" 和其他插件：

   a. 首先，点击 "Source Control Integration" 插件旁边的 "安装" 链接。

   b. 接着，点击任何其他适用于您仓库的 Source Control 插件旁边的 "安装" 链接。

6. 点击 "Source Control Integration" 插件进行配置。

   注意：为了通过 shell 导入更改集，必须设置一个 API 密钥。要生成一个随机密钥，运行

   ```bash
   openssl rand -hex 12
   ```
   

7. 转到 "仓库" 并输入您的仓库名称，选择仓库类型，然后点击 "创建仓库" 开始添加您的第一个仓库。

8. 根据 relevant 插件扩展的特定文档配置仓库：

   • SourceGithub
   • SourceGitlab
   • SourceAzureDevOps
   • SourceViewVC
   • SourceSVN
   • SourceVisualSVNServer

9. 配置完成后，点击 "返回仓库" 链接，然后点击 "导入全部" 或 "导入最新数据" 按钮以执行仓库更改集的初始导入并验证配置。

10. 确定您的仓库配置正确无误且运行正常后，您可以通过在托管您的 Mantis 安装的 Web 服务器上配置一个 cron 作业来自动导入新的更改集：

    • 使用 curl 导入（对于大型仓库可能会遇到超时，或者阻塞您的 Web 服务器）

      curl "http://host.domain.tld/mantisbt/plugin.php?page=Source/import&id=all&api_key=<YOUR_API_KEY>"
      

    • 使用 shell 导入

      php-cgi -f plugin.php page=Source/import id=all api_key=<YOUR_API_KEY>
      

      请注意 php-cgi 和 php-cli 之间的 区别。使用 php-cli 将不会运行导入。

    这将为所有配置的仓库导入新的更改集。

11. 您还可以配置基于事件的导入方式，许多源控制系统支持可配置的钩子或触发器，可以用来通知 Source 插件有新的提交或修订可用于导入。这样可以提高用户体验，消除了源代码提交与 MantisBT 状态更新之间的延迟。

    请参阅 relevant 插件扩展的配置文档了解更多信息。

12. 按需要添加其他仓库。

2. 项目使用说明

请参考以上安装指南来配置和使用 Mantis Source Integration 插件。确保按照相关文档正确配置每个仓库，以便插件能够正常工作。

3. 项目API使用文档

目前没有公开详细的 API 文档，但插件的 API 基于类的结构，允许访问数据库中的对象。

4. 项目安装方式

请按照上述安装指南中详细描述的步骤进行安装。确保遵循兼容性指导，并正确配置您的 MantisBT 版本和所需插件。