Improve documentation for GitHub Enterprise Importer migration log (#48138)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
Tim Rogers
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Accessing your migration logs for GitHub Enterprise Importer
|
||||
shortTitle: Access migration logs
|
||||
intro: 'To review a record of events and errors that occurred during a repository migration, you can access the migration log on {% data variables.product.prodname_dotcom %} or using the {% data variables.product.prodname_cli %}.'
|
||||
intro: "After running a migration, you should review the migration log to check for data that didn't migrate as expected."
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -13,12 +13,14 @@ redirect_from:
|
||||
|
||||
## About migration logs
|
||||
|
||||
Each time you run a migration with {% data variables.product.prodname_importer_proper_name %}, a migration log is created. The migration log lists the steps that were completed as part of the migration and includes additional information.
|
||||
Each time you run a migration with {% data variables.product.prodname_importer_proper_name %}, a migration log is created. You should check the migration log after every migration to review any migration warnings.
|
||||
|
||||
The migration log lists the steps that were completed as part of the migration and includes additional information.
|
||||
|
||||
- Migration warnings, representing data (such as issues, pull requests, or comments) that didn't migrate as expected
|
||||
- Who ran the migration
|
||||
- The source of the migration
|
||||
- How long the migration took
|
||||
- Any resources that didn't migrate as expected
|
||||
|
||||
You can access the migration log for a repository migration in multiple ways.
|
||||
|
||||
@@ -27,7 +29,7 @@ You can access the migration log for a repository migration in multiple ways.
|
||||
|
||||
When you run an organization migration, {% data variables.product.prodname_importer_proper_name %} additionally creates a repository named `gei-migration-results` in the destination organization. This repository contains information about the migration of organization-level data and duplicates the information in the "Migration Log" issues for each migrated repository.
|
||||
|
||||
For more information about interpreting error messages in your migration log, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer#troubleshooting-successful-migrations)."
|
||||
For more information about interpreting warnings in your migration log, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer#understanding-migration-log-warnings)."
|
||||
|
||||
## Viewing a repository migration log on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
|
||||
@@ -123,22 +123,24 @@ If you receive a `Git source migration failed` error with `GH007: Your push woul
|
||||
|
||||
To resolve this error, you can either rewrite the Git history to remove the email address, or you can disable the "Block command line pushes that expose my email" setting.
|
||||
|
||||
## Troubleshooting successful migrations
|
||||
## Understanding migration log warnings
|
||||
|
||||
If your migration succeeds but produces unexpected results, review the migration log for error messages. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer)."
|
||||
Even if your migration succeeds, you should still review the migration log to check for warnings.
|
||||
|
||||
Warnings in the migration log point to specific items within the repository which could not be migrated. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer)."
|
||||
|
||||
{% data reusables.enterprise-migration-tool.migration-log-errors-okay %}
|
||||
|
||||
- [Repository metadata too big to migrate](#repository-metadata-too-big-to-migrate)
|
||||
- [Comment not in diff](#comment-not-in-diff)
|
||||
- [Pull request review thread not migrated in pull request](#pull-request-review-thread-not-migrated-in-pull-request)
|
||||
- [Warning: "Repository metadata too big to migrate"](#warning-repository-metadata-too-big-to-migrate)
|
||||
- [Warning: "Comment not in diff"](#warning-comment-not-in-diff)
|
||||
- [Warning: "Pull Request Review...could not be imported due to REVIEW_THREAD_MISSING_END_COMMIT_OID error"](#warning-pull-request-reviewcould-not-be-imported-due-to-review_thread_missing_end_commit_oid-error)
|
||||
- [Team references are broken after an organization migration](#team-references-are-broken-after-an-organization-migration)
|
||||
|
||||
### Repository metadata too big to migrate
|
||||
### Warning: "Repository metadata too big to migrate"
|
||||
|
||||
If you see "Repository metadata too big to migrate" in the "Migration Log" issue or the {% data variables.product.prodname_cli %}, your repository exceeds the maximum archive size of 10 GB. This is often caused by large release assets. Try excluding releases from the migration with the `--skip-releases` flag for the `migrate-repo` command.
|
||||
|
||||
### Comment not in diff
|
||||
### Warning: "Comment not in diff"
|
||||
|
||||
If you're migrating from Azure DevOps, pull request comments on lines that were never changed in the pull request cannot be migrated to {% data variables.product.prodname_dotcom %}. You'll see this warning for every comment that cannot be migrated for this reason.
|
||||
|
||||
@@ -150,17 +152,13 @@ If you're migrating from Azure DevOps, pull request comments on lines that were
|
||||
|
||||
Be aware that the affected comments will not be in the migrated repository, but these warnings do not require further action from you.
|
||||
|
||||
### Pull request review thread not migrated in pull request
|
||||
### Warning: "Pull Request Review...could not be imported due to REVIEW_THREAD_MISSING_END_COMMIT_OID error"
|
||||
|
||||
This warning is a more generic form of "Comment not in diff." If you see this warning, a comment on a file in a pull request couldn’t be migrated for a different reason than the one described above. Most often, the comment was on a line that was changed at one point in the pull request history, but then the pull request changed so that this was no longer the case.
|
||||
This warning occurs where a pull request review could not be migrated because the commit that the review is attached to no longer exists.
|
||||
|
||||
- The comment is on a file that was deleted later in the pull request history.
|
||||
- The comment was on code that was changed at one point in the pull request history, but the author later decided to remove the change.
|
||||
- The pull request was squash merged into a single commit, which prevents {% data variables.product.company_short %} from being able to properly construct the pull request history to properly place the comment.
|
||||
This usually happens where commits have been removed with a force push, or a branch has been deleted.
|
||||
|
||||
This problem most frequently impacts closed pull requests.
|
||||
|
||||
Be aware that the affected comments will not be in the migrated repository, but these warnings do not require further action from you.
|
||||
In this case, the comments are not lost, but are migrated as inline pull request comments to preserve history, rather than as a review attached to a specific commit.
|
||||
|
||||
### Team references are broken after an organization migration
|
||||
|
||||
|
||||
@@ -129,6 +129,7 @@ For repository migrations, we recommend creating a test organization to use as a
|
||||
|
||||
{% data reusables.enterprise-migration-tool.follow-up-tasks-intro %}
|
||||
|
||||
- [Checking the migration status](#checking-the-migration-status)
|
||||
- [Reviewing the migration log](#reviewing-the-migration-log)
|
||||
- [Migrating {% data variables.large_files.product_name_short %} objects](#migrating-git-lfs-objects)
|
||||
- [Setting repository visibility](#setting-repository-visibility)
|
||||
@@ -140,6 +141,10 @@ For repository migrations, we recommend creating a test organization to use as a
|
||||
- [Recreating teams](#recreating-teams)
|
||||
- [Reclaiming mannequins](#reclaiming-mannequins)
|
||||
|
||||
### Checking the migration status
|
||||
|
||||
{% data reusables.enterprise-migration-tool.checking-the-migration-status %}
|
||||
|
||||
### Reviewing the migration log
|
||||
|
||||
{% data reusables.enterprise-migration-tool.reviewing-the-migration-log %}
|
||||
|
||||
@@ -104,12 +104,17 @@ We recommend creating a test organization to use as a destination for your trial
|
||||
|
||||
{% data reusables.enterprise-migration-tool.follow-up-tasks-intro %}
|
||||
|
||||
- [Checking the migration status](#checking-the-migration-status)
|
||||
- [Reviewing the migration log](#reviewing-the-migration-log)
|
||||
- [Setting repository visibility](#setting-repository-visibility)
|
||||
- [Configuring permissions](#configuring-permissions)
|
||||
- [Reclaiming mannequins](#reclaiming-mannequins)
|
||||
- [Configuring IP allow lists](#configuring-ip-allow-lists)
|
||||
|
||||
### Checking the migration status
|
||||
|
||||
{% data reusables.enterprise-migration-tool.checking-the-migration-status %}
|
||||
|
||||
### Reviewing the migration log
|
||||
|
||||
{% data reusables.enterprise-migration-tool.reviewing-the-migration-log %}
|
||||
|
||||
@@ -97,12 +97,17 @@ We recommend creating a test organization to use as a destination for your trial
|
||||
|
||||
{% data reusables.enterprise-migration-tool.follow-up-tasks-intro %}
|
||||
|
||||
- [Checking the migration status](#checking-the-migration-status)
|
||||
- [Reviewing the migration log](#reviewing-the-migration-log)
|
||||
- [Setting repository visibility](#setting-repository-visibility)
|
||||
- [Configuring permissions](#configuring-permissions)
|
||||
- [Reclaiming mannequins](#reclaiming-mannequins)
|
||||
- [Configuring IP allow lists](#configuring-ip-allow-lists)
|
||||
|
||||
### Checking the migration status
|
||||
|
||||
{% data reusables.enterprise-migration-tool.checking-the-migration-status %}
|
||||
|
||||
### Reviewing the migration log
|
||||
|
||||
{% data reusables.enterprise-migration-tool.reviewing-the-migration-log %}
|
||||
|
||||
Reference in New Issue
Block a user