Exporting migration data from GitHub.com

Preparing the source organization on GitHub

1. Ensure that you have owner permissions on the source organization's repositories.

2. 生成范围为 repo 和 admin:org 的访问令牌。 on GitHub.com.

3. 为尽量减少停机，请创建要从源实例导出的仓库列表。 您可以使用每行列出一个仓库 URL 的文本文件一次性导出多个仓库。

Exporting the organization's repositories

To export repository data from GitHub.com, use the Migrations API.

The Migrations API is currently in a preview period, which means that the endpoints and parameters may change in the future.

Generating a migration archive

1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "About Migrations."

2. Start a migration by sending a POST request to the migration endpoint. You'll need:

   • Your access token for authentication.
   • A list of the repositories you want to migrate:

     curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \
     -X POST \
     -H "Accept: application/vnd.github.v3+json" \
     -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \
     https://api.github.com/orgs/orgname/migrations

   • If you want to lock the repositories before migrating them, make sure lock_repositories is set to true. This is highly recommended.
   • You can exclude file attachments by passing exclude_attachments: true to the endpoint. 文件附件可能很大，可能不必要地胀大您的最终迁移存档。 The final archive size must be less than 20 GB.

   This request returns a unique id which represents your migration. You'll need it for subsequent calls to the Migrations API.

3. Send a GET request to the migration status endpoint to fetch the status of a migration. You'll need:

   • Your access token for authentication.
   • The unique id of the migration:

     curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \
     -H "Accept: application/vnd.github.v3+json" \
     https://api.github.com/orgs/orgname/migrations/id

   A migration can be in one of the following states:

   • pending, which means the migration hasn't started yet.
   • exporting, which means the migration is in progress.
   • exported, which means the migration finished successfully.
   • failed, which means the migration failed.

4. After your migration has exported, download the migration archive by sending a GET request to the migration download endpoint. You'll need:

   • Your access token for authentication.
   • The unique id of the migration:

     curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \
     -H "Accept: application/vnd.github.v3+json" \
     -L -o migration_archive.tar.gz \
     https://api.github.com/orgs/orgname/migrations/id/archive

5. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a DELETE request to the migration archive delete endpoint. You'll need:

   • Your access token for authentication.
   • The unique id of the migration:

     curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \
     -X DELETE \
     -H "Accept: application/vnd.github.v3+json" \
     https://api.github.com/orgs/orgname/migrations/id/archive

6. 要将存档的迁移数据导入到 GitHub Enterprise Server 实例，请参阅“准备将数据迁移到企业”。