Migrate your repositories from GitLab to GitHub

Prerequisites

• You must have completed all previous phases of this guide.
• The GitLab project must be enabled for exports. See Enable project export and Sidekiq configuration for imports in the GitLab documentation.
• 确保了解将要迁移的数据以及导入程序已知的支持限制。 For more information, see Understand migrations from GitLab to GitHub.
• 虽然并非必需，但建议在生产迁移期间停止工作。 Importer 不支持增量迁移，因此迁移期间发生的任何更改都不会迁移。 如果选择在生产迁移期间不停止工作，需要手动迁移这些更改。

Performing a trial run

为了帮助发现企业可能特有的问题，我们因此强烈建议进行迁移的试运行。 通过试用运行，你将了解：

• 给定存储库的迁移是否可以成功完成。
• 是否可以将迁移的存储库恢复为可行的状态。
• 迁移运行需要多长时间。

试用版运行可以随时进行，在迁移期间无需停止工作。 为了减少完成试迁移所需的时间，可以计划连续安排试运行的批次。 然后，这些存储库的用户可以在自己方便的时候进行结果验证。

1. Create a test organization for your trial migrations.

   You can use a single organization for all trial runs, or you can create one test organization for each intended destination organization. Consider including -sandbox at the end of the organization names, to clarify that the organizations are intended only for migration validation and not for production. You can delete the test organizations after you're done.

2. Run the trial migrations.

3. Confirm that you are able to complete the follow-up tasks in Follow-up tasks.

4. Ask users to validate the results of the migrations.

5. Resolve any issues uncovered by your trial migrations.

6. （可选）删除测试组织。

Migrating a single repository

To migrate one repository, use the gh gl2gh migrate-repo command.

gh gl2gh migrate-repo \
  --gitlab-server-url GITLAB_SERVER_URL \
  --gitlab-group SOURCE_GROUP \
  --gitlab-project SOURCE_PROJECT \
  --github-org DESTINATION \
  --github-repo NEW_REPO_NAME \
  --use-github-storage

gh gl2gh migrate-repo \
  --gitlab-server-url GITLAB_SERVER_URL \
  --gitlab-group SOURCE_GROUP \
  --gitlab-project SOURCE_PROJECT \
  --github-org DESTINATION \
  --github-repo NEW_REPO_NAME \
  --use-github-storage

Replace the placeholders in the command above with the following values.

If you are not using GitHub-owned blob storage, see Configure blob storage.

Additional arguments

Generating a migration script

If you want to migrate multiple repositories to GitHub Enterprise Cloud at once, use the GitHub CLI to generate a migration script. The resulting script contains one migrate-repo command per repository.

To generate a migration script, run the gh gl2gh generate-script command.

gh gl2gh generate-script \
  --gitlab-server-url GITLAB_SERVER_URL \
  --github-org DESTINATION \
  --output FILENAME \
  --use-github-storage

gh gl2gh generate-script \
  --gitlab-server-url GITLAB_SERVER_URL \
  --github-org DESTINATION \
  --output FILENAME \
  --use-github-storage

Replace the placeholders in the command above with the following values.

By default, the script includes every project the token can access. To scope the script, add --gitlab-group GROUP, or --gitlab-group GROUP --gitlab-project PROJECT for a single project.

If you are not using GitHub-owned blob storage, see Configure blob storage.

Additional arguments

Reviewing the migration script

After you generate the script, review the file and, optionally, edit the script.

• If there are any repositories you don't want to migrate, delete or comment out the corresponding lines.
• If you want any repositories to have a different name in the destination organization, update the value for the corresponding --github-repo flag.
• If you want to change the visibility of a new repository, add or update the corresponding --target-repo-visibility flag.

Migrate repositories

If your trial run was successful, and you were able to complete the follow-up tasks, you can proceed to the real migration.

Run the script you generated. Replace FILENAME in the commands below with the filename you provided when generating the script.

• If you're using Terminal, use ./.

  Shell

  ./FILENAME
  

• If you're using PowerShell, use .\.

  Shell

  .\FILENAME