GitHub、Gitlab连接器

连接器将自动同步您GitHub、Gitlab仓库的源文件与YiCAT项目的翻译内容，所有译文文件都将通过自动发送拉取请求（Pull Request），推送至代码仓库的本地化分支。推送成功的文件，可通过合并拉取请求（Merge Pull Request）的方式，将本地化分支合并到源分支中。

YiCAT支持与GitHub、GitLab及GitLab私有版集成。

适用版本

企业旗舰版

适用角色

项目经理、管理员、超级管理员

如何在项目中创建连接

在项目详情页，点击【连接器】标签页，进入连接器配置界面。
点击【创建连接】按钮，弹出“选择应用”弹窗，选择“GitHub”、“GitLab”或“私有GitLab”应用，点击【确定】按钮。
如您选择连接GitHub或GitLab，则网页将自动跳转至相应登录授权页面。输入您的账号、密码，点击登录并授权。操作成功后，网页将重定向至YiCAT，您可进行下一步操作。
如您选择连接私有GitLab，则需要您填写您GitLab账号的Personal access token 及 Host URL 。填写完毕后点击【确定】按钮，可进行下一步操作。

注： Personal access token 获取方法参考：

在“创建连接”弹窗中，您可配置拉取、推送的分支，并设置推送方式。点击选择待拉取仓库，检索或直接点击选中该仓库下的对应待译分支，即可在弹窗中间看到已选中的拉取及预备推送分支。系统默认推送至“l10n-{待译分支名}”分支，您也可手动修改。支持一次性新建多个拉取及推送分支的连接。如您的项目迭代节奏较快，希望平台能够定时自动拉取原文并推送译文，可点击选中“自动拉取和推送”模式，平台将按照您设置的规则自动操作。原文及译文的更新（拉取/推送）时间可按照分钟、小时和某天某时推送。

某天：每天、周一、周二、周三、周四、周五、周六、周日推送
某时（北京时间）：0:00~24:00，选项间隔为30分钟。如您希望仅在需要的时间手动拉取和推送，选择“手动拉取和推送”即可。后续可在连接器页面进行手动同步。 YiCAT最新译文向Github、Gitlab推送后，会发送一条拉取请求。默认拉取请求文案为“New YiCAT updates”；您也可手动修改。完成上述配置，点击【创建】按钮，即可成功新建连接。
注：单次创建连接仅允许在一个仓库中选择分支，如您需要配置多个仓库下的分支，分多次创建即可。连接器页面将平铺展示各仓库及仓库下对应连接。

如何选择拉取文件并配置推送路径

连接创建成功后，即可在“连接器”页面，对连接的推送路径等进行进一步配置。

点击连接右侧的“待配置”图标，前往配置页面。
在“修改连接配置”弹窗中，点击“新建配置”按钮，新增配置。
根据您的业务需求，选择按照路径或PR选择待译文件。注意文件夹是无法直接被选中的，您需要选中具体的一个或多个文件，也可以快速全选某个文件夹下的所有文件。如您选择按照路径选择文件，可在检索栏中直接输入文件名快速定位，也可在下方列表中滚动查看。支持同时选中不同路径层级下的文件，您可点击路径层级、文件夹或返回上一层级“···”来切换路径。点击勾选一个或多个待译文件，已选中的文件将在右侧面板展示。YiCAT暂不支持的文件格式，则文件底色为灰色且不支持选中。选择完成后，点击【确认】按钮。如您选择按照PR选择文件，可根据Head检索PR，点击PR并选中相应文件。在右侧可以进行二次确认。YiCAT暂不支持的文件格式，则文件底色为灰色且不支持选中。选择完成后，点击【确认】按钮。文件选择完毕，点击可编辑推送路径。YiCAT支持输入%original_path%、%locale%和%original_file_name%三个变量，也支持手动输入自定义内容。输入完成后，点击【保存】按钮即可保存您的配置。如您的文件推送规则较复杂，可新建多个配置。多个配置可以同时起作用，您可在右侧面板中看到各配置累加选中的文件，支持移除不需要的文件。

如何同步原文和译文

如您在创建连接时，选择了“自动拉取和推送”模式，平台将按照您设置的规则定时自动进行拉取原文和推送译文的操作。
如您在创建连接时，选择了“手动拉取和推送”模式，或有即时同步原文和译文的需求，则可点击“同步”按钮进行同步操作。
您可点击仓库右上方的“同步”按钮，同步该仓库下的所有连接。系统会拉取代码仓库中的最新原文并推送YiCAT上的最新译文；
您也可点击连接右侧的“同步”按钮，同步该连接的原文和译文。系统会拉取代码仓库中的最新原文并推送YiCAT上的最新译文。
点击“同步”按钮，系统将提示您“提交同步成功”，连接状态变为“同步中”。同步完成后，连接状态将变为“同步”。如提示“同步失败”，请确认您的网络状态或配置是否正确，调整并再次点击“同步”按钮即可。
同步成功后，您在“文件-文件详情”中即可查看同步的文件，点击文件名称可进入编辑器进行编辑操作。通过连接器上传的文件，右上方将展示连接器标识。点击文件列表右上方【显示字段】图标，可选择显示文件路径，更加直观。如何修改或删除连接器配置

如您想修改仓库下各连接推送配置，可在“连接器”页面点击【设置】按钮，选择“修改推送方式”，后续操作参考“如何在项目中创建连接”。
如您想修改某个连接的相关配置，可在“连接器”页面点击“修改配置”图标，后续操作参考“如何选择拉取文件并配置推送路径”。
如您想删除某仓库下所有连接，可“连接器”页面点击【设置】按钮，选择“删除此仓库连接”，在弹窗中点击“确定”即可。
如您想删除仓库下某个连接，可“连接器”页面点击【设置】按钮，选择“修改推送方式”，在弹窗中取消勾选相应待译分支，点击【保存】按钮，并在弹窗中点击“删除”再次确认即可。注意连接被删除后，分支对应的配置信息也会随之删除，不可恢复。
注：删除连接后，YiCAT项目中的文件将不会被删除。