关于使用 GitHub Enterprise Importer 进行存储库迁移
你可以使用 GitHub CLI 或 API 运行迁移。
GitHub CLI 简化了迁移流程,建议大多数客户使用。有大量定制需求的高级客户可以使用 API 与 GitHub Enterprise Importer 构建自己的集成。
先决条件
- 我们强烈建议你对迁移进行试运行,并在不久后完成生产迁移。要了解有关试运行的更多信息,请参阅“GitHub 产品之间的迁移概述”。
- 确保了解将要迁移的数据以及 Importer 的已知支持限制。有关更多信息,请参阅“GitHub 产品之间的迁移”。
- 虽然不是必需的,但我们建议在生产迁移期间停止工作。Importer 不支持增量迁移,因此在迁移期间发生的任何更改都不会迁移。如果你选择在生产迁移期间不停止工作,则需要手动迁移这些更改。
- 在源组织和目标组织中,你必须是组织所有者或被授予迁移者角色。有关更多信息,请参阅“管理 GitHub 产品之间的迁移访问权限”。
步骤 0:做好使用 GitHub GraphQL API 的准备
要进行 GraphQL 查询,您需要编写自己的脚本或使用 HTTP 客户端,如 Insomnia。
要详细了解如何开始使用 GitHub GraphQL API,包括如何进行身份验证,请参阅“使用 GraphQL 形成调用”。
步骤 1:获取迁移目标的 ownerId
作为 GitHub Enterprise Cloud 中的组织所有者,使用 GetOrgInfo
查询以返回您想要拥有已迁移存储库的组织的 ownerId
,也称为组织 ID。您需要 ownerId
来标识您的迁移目标。
GetOrgInfo
查询
query(
$login: String!
){
organization (login: $login)
{
login
id
name
databaseId
}
}
查询变量 | 说明 |
---|---|
login | 您的组织名称。 |
GetOrgInfo
响应
{
"data": {
"organization": {
"login": "Octo",
"id": "MDEyOk9yZ2FuaXphdGlvbjU2MTA=",
"name": "Octo-org",
"databaseId": 5610
}
}
}
在此示例中,MDEyOk9yZ2FuaXphdGlvbjU2MTA=
是组织 ID 或 ownerId
,我们将在下一步中使用它。
步骤 2:确定您要从何处进行迁移
您可以使用 createMigrationSource
查询设置迁移源。您需要提供从 GetOrgInfo
查询中收集的 ownerId
或组织 ID。
您的迁移源是 GitHub.com 上的一个组织。
createMigrationSource
突变
mutation createMigrationSource($name: String!, $ownerId: ID!) {
createMigrationSource(input: {name: $name, url: "https://github.com", ownerId: $ownerId, type: GITHUB_ARCHIVE}) {
migrationSource {
id
name
url
type
}
}
}
注意:确保为 type
使用 GITHUB_ARCHIVE
。
查询变量 | 说明 |
---|---|
name | 您的迁移源的名称。此名称供您自己参考,因此您可以使用任何字符串。 |
ownerId | 您在 GitHub Enterprise Cloud 上的组织的组织 ID。 |
createMigrationSource
响应
{
"data": {
"createMigrationSource": {
"migrationSource": {
"id": "MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA",
"name": "GitHub.com Source",
"url": "https://github.com",
"type": "GITHUB_SOURCE"
}
}
}
}
在此示例中,MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA
是迁移源 ID,我们将在下一步中使用它。
步骤 3:开始您的存储库迁移
当您开始迁移时,单个存储库及其随附数据将迁移到您标识的全新 GitHub 存储库中。
如果您想一次从同一源组织中移动多个存储库,您可以排队进行多次迁移。您可以同时运行最多 5 次存储库迁移。
startRepositoryMigration
突变
mutation startRepositoryMigration (
$sourceId: ID!,
$ownerId: ID!,
$sourceRepositoryUrl: URI!,
$repositoryName: String!,
$continueOnError: Boolean!,
$accessToken: String!,
$githubPat: String!,
$targetRepoVisibility: String!
){
startRepositoryMigration( input: {
sourceId: $sourceId,
ownerId: $ownerId,
repositoryName: $repositoryName,
continueOnError: $continueOnError,
accessToken: $accessToken,
githubPat: $githubPat,
targetRepoVisibility: $targetRepoVisibility
sourceRepositoryUrl: $sourceRepositoryUrl,
}) {
repositoryMigration {
id
migrationSource {
id
name
type
}
sourceUrl
}
}
}
查询变量 | 说明 |
---|---|
sourceId | 从 createMigrationSource 变异返回的迁移源 id 。 |
ownerId | 您在 GitHub Enterprise Cloud 上的组织的组织 ID。 |
repositoryName | 组织在 GitHub Enterprise Cloud 中拥有的任何存储库当前未使用的自定义唯一存储库名称。迁移完成后或停止后,将在该存储库中创建一个错误日志问题。 |
continueOnError | 迁移设置,允许迁移在遇到不会导致迁移失败的错误时继续进行。必须为 true 或 false 。我们强烈建议将 continueOnError 设置为 true ,以便在导入程序无法移动 Git 源或导入程序失去连接且无法重新连接以完成迁移时,迁移才会继续进行。 |
githubPat | GitHub Enterprise Cloud 上目标组织的个人访问令牌。 |
accessToken | 源的个人访问令牌。 |
targetRepoVisibility | 新存储库的可见性。必须为 private 、public 或 internal 。如果未设置,则存储库将以私有方式迁移。 |
sourceRepositoryUrl | 源存储库的 URL,格式为 https://github.com/{organization}/{repository} 。 |
有关个人访问令牌要求,请参阅“管理 GitHub 产品之间的迁移的访问权限”。
在下一步中,你将使用从 startRepositoryMigration
变异返回的迁移 ID 来检查迁移状态。
步骤 4:检查迁移状态
要检测任何迁移故障并确保迁移正常运行,可以使用 getMigration
查询检查迁移状态。你还可以使用 getMigrations
检查多个迁移的状态。
getMigration
查询将返回一个状态,让你知道迁移是 queued
、in progress
、failed
还是 completed
。如果迁移失败,导入程序将提供失败原因。
getMigration
查询
query (
$id: ID!
){
node( id: $id ) {
... on Migration {
id
sourceUrl
migrationSource {
name
}
state
failureReason
}
}
}
查询变量 | 说明 |
---|---|
ID | startRepositoryMigration 变更返回的迁移的 id 。 |
第 5 步:验证迁移并检查错误日志
为了完成迁移,我们建议你检查“迁移日志”问题。此问题在目标存储库中的 GitHub 上创建。
最后,我们建议你查看已迁移的存储库以进行健全性检查。
第 1 步:安装 GitHub CLI 的 GEI 扩展
如果这是你的首次迁移,你需要安装 GitHub CLI 的 GEI 扩展。有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。
或者,你可以从 github/gh-gei
存储库的发行页下载独立二进制文件。你可以直接运行二进制文件,而无需 gh
前缀。
-
安装 GitHub CLI。有关 GitHub CLI 的安装说明,请参阅GitHub CLI 存储库。
注意:你需要 GitHub CLI 的 2.4.0 或更高版本。你可以使用
gh --version
命令检查已安装的版本。 -
安装 GEI 扩展。
Shell gh extension install github/gh-gei
gh extension install github/gh-gei
任何时候,如果你需要 GEI 扩展的帮助,你可以对命令使用 --help
标志。例如,gh gei --help
将列出所有可用的命令,而 gh gei migrate-repo --help
将列出 migrate-repo
命令可用的所有选项。
第 2 步:更新 GitHub CLI 的 GEI 扩展
GEI 扩展每周更新一次。为了确保你使用的是最新版本,请更新扩展。
gh extension upgrade github/gh-gei
第 3 步:设置环境变量
在你可以使用 GEI 扩展迁移到 GitHub Enterprise Cloud 之前,你必须创建可以访问源组织和目标组织的个人访问令牌,然后将个人访问令牌设置为环境变量。
-
创建并记录一个个人访问令牌(经典),该令牌将对 GitHub Enterprise Cloud 上的目标组织进行身份验证,确保令牌满足所有要求。有关详细信息,请参阅“管理 GitHub 产品之间的迁移访问权限”。
-
创建并记录一个个人访问令牌,该令牌将对源组织进行身份验证,确保此令牌也满足所有相同要求。
-
为个人访问令牌设置环境变量,使用以下命令中的 TOKEN 替换为上面记录的个人访问令牌。对目标组织使用
GH_PAT
,对源组织使用GH_SOURCE_PAT
。-
如果您使用终端,请使用
export
命令。Shell export GH_PAT="TOKEN" export GH_SOURCE_PAT="TOKEN"
export GH_PAT="TOKEN" export GH_SOURCE_PAT="TOKEN"
-
如果您使用 PowerShell,请使用
$env
命令。Shell $env:GH_PAT="TOKEN" $env:GH_SOURCE_PAT="TOKEN"
$env:GH_PAT="TOKEN" $env:GH_SOURCE_PAT="TOKEN"
-
步骤 4:生成迁移脚本
如果您希望一次性将多个存储库迁移到 GitHub Enterprise Cloud,请使用 GitHub CLI 生成迁移脚本。生成的脚本将包含一个迁移命令列表,每个存储库一个命令。
如果您希望迁移单个存储库,请跳至下一步。
生成迁移脚本
要生成迁移脚本,请运行 gh gei generate-script
命令。
gh gei generate-script --github-source-org SOURCE --github-target-org DESTINATION --output FILENAME
gh gei generate-script --github-source-org SOURCE --github-target-org DESTINATION --output FILENAME
如果您希望脚本下载每个已迁移存储库的迁移日志,请添加 --download-migration-logs
标志。有关迁移日志的详细信息,请参阅“访问 GitHub Enterprise Importer 的迁移日志”。
用以下值替换上述命令中的占位符。
占位符 | 值 |
---|---|
SOURCE | 源组织的名称 |
DESTINATION | 目标组织的名称 |
FILENAME | 生成的迁移脚本的文件名 如果您使用终端,请使用 .ps1 文件扩展名,因为生成的脚本需要 PowerShell 才能运行。您可以为 Mac 或 Linux 安装 PowerShell。 |
如果您下载 GEI 作为独立二进制文件,而不是作为 GitHub CLI 的扩展,您需要更新生成的脚本,以运行二进制文件,而不是 gh gei
。
查看迁移脚本
生成脚本后,查看文件并根据需要编辑脚本。
- 如果您不想迁移任何存储库,请删除或注释掉相应的行。
- 如果您希望任何存储库在目标组织中具有不同的名称,请更新相应
--target-repo
标志的值。
注意:如果您的存储库有超过 10 GB 的发行版数据,则无法迁移发行版。使用 --skip-releases
标志在不发行版的情况下迁移存储库。
如果您下载 GEI 作为独立二进制文件,而不是作为 GitHub CLI 的扩展,您需要更新生成的脚本,以运行二进制文件,而不是 gh gei
。
步骤 5:迁移存储库
您可以使用迁移脚本迁移多个存储库,或使用 gh gei migrate-repo
命令迁移单个存储库。
迁移多个存储库
要迁移多个存储库,请运行上面生成的脚本。用生成脚本时提供的文件名替换以下命令中的 FILENAME。
-
如果您使用终端,请使用
./
。Shell ./FILENAME
./FILENAME
-
如果您使用 PowerShell,请使用
.\
。Shell .\FILENAME
.\FILENAME
迁移单个存储库
要迁移单个存储库,请使用 gh gei migrate-repo
命令。
gh gei migrate-repo --github-source-org SOURCE --source-repo CURRENT-NAME --github-target-org DESTINATION --target-repo NEW-NAME
gh gei migrate-repo --github-source-org SOURCE --source-repo CURRENT-NAME --github-target-org DESTINATION --target-repo NEW-NAME
注意:如果您的存储库有超过 10 GB 的发行版数据,则无法迁移发行版。使用 --skip-releases
标志在不发行版的情况下迁移存储库。
用以下值替换上述命令中的占位符。
占位符 | 值 |
---|---|
SOURCE | 源组织的名称 |
CURRENT-NAME | 您要迁移的存储库的名称 |
DESTINATION | 目标组织的名称 |
NEW-NAME | 您希望迁移的存储库具有的名称 |
如果您想取消迁移,请使用 abort-migration
命令,用 migrate-repo
返回的 ID 替换 MIGRATION-ID。
gh gei abort-migration --migration-id MIGRATION-ID
gh gei abort-migration --migration-id MIGRATION-ID
步骤 6:验证迁移并检查错误日志
迁移完成后,我们建议您查看迁移日志。有关更多信息,请参阅“访问 GitHub Enterprise Importer 的迁移日志”。
我们建议您查看已迁移的存储库,以进行健全性检查。