FBShipIt 开源项目使用教程

FBShipIt 开源项目使用教程

fbshipitCopy commits between repositories · git → git, git → hg, hg → hg, or hg → git项目地址:https://gitcode.com/gh_mirrors/fb/fbshipit

1. 项目介绍

FBShipIt 是一个由 Facebook 开源的库，用于在不同版本控制系统（如 Git 和 Mercurial）之间复制提交。它主要用于将提交从一个仓库复制到另一个仓库，支持多种组合，如 Git 到 Git、Git 到 Mercurial、Mercurial 到 Mercurial 以及 Mercurial 到 Git。FBShipIt 的设计目标是处理线性历史分支，并且不理解合并提交。

主要功能

• 从 Git 或 Mercurial 仓库读取提交
• 写入 Git 或 Mercurial 仓库
• 移除匹配特定模式的文件或目录
• 移除或重写提交消息的某些部分
• 修改提交作者（例如，将内部提交的作者恢复为原始作者）

2. 项目快速启动

安装

首先，确保你已经安装了 HHVM 和 Composer。然后，通过 Composer 安装 FBShipIt：

$ composer require facebook/fbshipit

配置

在开始使用 FBShipIt 之前，你需要配置 GitHub 凭证。打开 DemoGitHubUtils.php 文件，并进行以下修改：

// 修改 $committer_user 为你的 GitHub 用户名
$committer_user = 'your_github_username';

// 可选：修改 $committer_email 和 $committer_name
$committer_email = 'your_email@example.com';
$committer_name = 'Your Name';

// 生成一个 GitHub 访问令牌，并替换 ACCESS_TOKEN_HERE
function getCredentialsForProject() {
    return [
        'access_token' => 'ACCESS_TOKEN_HERE',
    ];
}

运行示例

在配置完成后，你可以运行 FBShipIt 的示例脚本来测试配置是否正确：

$ php demo/run.php

3. 应用案例和最佳实践

应用案例

FBShipIt 主要用于以下场景：

• 将提交从一个大型 Monorepo 复制到多个项目特定的 GitHub 仓库
• 同步来自不同项目的更改，如 CPython 和 Linux 内核
• 将 PyTorch 的更改导入到 Mercurial 单仓库中

最佳实践

• 线性历史：FBShipIt 最适合处理线性历史分支，避免使用合并提交。
• 安全凭证：确保 GitHub 访问令牌不会被意外提交到版本控制系统中。
• 过滤器使用：利用过滤器功能来修改提交内容，如移除敏感信息或重写提交消息。

4. 典型生态项目

FBShipIt 通常与其他开源项目结合使用，以实现更复杂的版本控制和同步需求。以下是一些典型的生态项目：

• Copybara：一个类似的开源工具，用于在不同仓库之间迁移代码。
• Git 和 Mercurial：FBShipIt 支持从这两种版本控制系统读取和写入提交。
• Composer：用于管理 PHP 项目的依赖关系，FBShipIt 通过 Composer 进行安装和依赖管理。

通过结合这些工具，FBShipIt 可以实现更高效的代码迁移和同步工作流。

fbshipitCopy commits between repositories · git → git, git → hg, hg → hg, or hg → git项目地址:https://gitcode.com/gh_mirrors/fb/fbshipit