From 1cf4f12119c2eaf5600c318aac773530a3c85478 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 10 Jan 2024 11:57:18 +0000 Subject: [PATCH 1/2] Improve documentation for GitHub Enterprise Importer migration log (#48138) Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> --- ...ion-logs-for-github-enterprise-importer.md | 10 ++++--- ...gration-with-github-enterprise-importer.md | 28 +++++++++---------- ...-of-a-migration-between-github-products.md | 5 ++++ ...azure-devops-to-github-enterprise-cloud.md | 5 ++++ ...ucket-server-to-github-enterprise-cloud.md | 5 ++++ .../checking-the-migration-status.md | 14 ++++++++++ .../migration-log-errors-okay.md | 2 +- .../reviewing-the-migration-log.md | 9 +++--- 8 files changed, 53 insertions(+), 25 deletions(-) create mode 100644 data/reusables/enterprise-migration-tool/checking-the-migration-status.md diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md index b4e4793f6b..ebcc9957bd 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer.md @@ -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 %} diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md index d90ad38e03..b74e364499 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md @@ -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 diff --git a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md index eded5b606e..1625bdd973 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md +++ b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md @@ -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 %} diff --git a/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md index 9ea70a078a..b4b2ea75cf 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md @@ -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 %} diff --git a/content/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/overview-of-a-migration-from-bitbucket-server-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/overview-of-a-migration-from-bitbucket-server-to-github-enterprise-cloud.md index 552ab2cbfe..59f769b7dc 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/overview-of-a-migration-from-bitbucket-server-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/overview-of-a-migration-from-bitbucket-server-to-github-enterprise-cloud.md @@ -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 %} diff --git a/data/reusables/enterprise-migration-tool/checking-the-migration-status.md b/data/reusables/enterprise-migration-tool/checking-the-migration-status.md new file mode 100644 index 0000000000..894ebda79b --- /dev/null +++ b/data/reusables/enterprise-migration-tool/checking-the-migration-status.md @@ -0,0 +1,14 @@ +First, check whether your migration succeeded or failed. + +The way you check the status of your migration depends on how you ran the migration. + +- If you ran the migration using the {% data variables.product.prodname_cli %}, by default, the process will display whether the migration succeeded or failed once the migration is complete. If the migration failed, you will see the reason for failure. + + ```text + Migration completed (ID: RM_123)! State: SUCCEEDED + ``` + +- If you ran the migration using the {% data variables.product.prodname_cli %} with the optional `--queue-only` argument, the process will exit immediately after queueing the migration, and will not tell you if the migration succeeded or failed. You can check a migration's status using the `wait-for-migration` command, or by reviewing the migration log. +- If you ran the migration using the GraphQL API, you can query the `state` and `failureReason` fields on the `RepositoryMigration` object. + +If the migration failed, the migration log may contain additional information about the cause of the failure. For more information, see "[Reviewing the migration log](#reviewing-the-migration-log)." diff --git a/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md b/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md index 53395a6fa9..4e47cfb956 100644 --- a/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md +++ b/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md @@ -1,5 +1,5 @@ {% note %} -**Note:** If the "Migration Log" issue includes "Migration completed" at the bottom, the repository was migrated. Error messages only indicate that specific items within the repository, such as a comment on a pull request, may not have migrated correctly. +**Note:** If the "Migration Log" issue includes "Migration completed" at the bottom, the repository was migrated. Warnings only indicate that specific items within the repository, such as a comment on a pull request, may not have migrated correctly. {% endnote %} diff --git a/data/reusables/enterprise-migration-tool/reviewing-the-migration-log.md b/data/reusables/enterprise-migration-tool/reviewing-the-migration-log.md index 81d01ae9c1..d72fe40c99 100644 --- a/data/reusables/enterprise-migration-tool/reviewing-the-migration-log.md +++ b/data/reusables/enterprise-migration-tool/reviewing-the-migration-log.md @@ -1,8 +1,7 @@ -First, review the migration log for each migrated repository. 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)." +Review the migration log for each migrated repository. 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)." -If any specific items within the repository could not be migrated, you'll see a warning in the migration log. +If the migration failed, the log may contain additional information about the cause of the failure. -{% data reusables.enterprise-migration-tool.migration-log-errors-okay %} +If the migration succeeded, there may be warnings in the migration log representing specific pieces of data (for example pull requests, issues, or comments) which were not migrated or were migrated with caveats. -1. Review your migration logs. -1. Review any warnings each log, and ensure that none are blocking the acceptance of the migration. For more information, 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 on understanding migration warnings, 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)." After reviewing any migration warnings, you will need to make a decision about whether you can accept those warnings and move forward. From ad3ad4cb537904e34671bbdcf44f50218531b974 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 10 Jan 2024 12:22:38 +0000 Subject: [PATCH 2/2] Bump file-type from 18.7.0 to 19.0.0 (#48636) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Peter Bengtsson --- package-lock.json | 10 +++++----- package.json | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index cc34d46d91..3f737054f1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35,7 +35,7 @@ "express-rate-limit": "7.0.0", "express-timeout-handler": "^2.2.2", "fastest-levenshtein": "1.0.16", - "file-type": "18.7.0", + "file-type": "19.0.0", "flat": "^6.0.1", "github-slugger": "^2.0.0", "glob": "10.0.0", @@ -7000,16 +7000,16 @@ } }, "node_modules/file-type": { - "version": "18.7.0", - "resolved": "https://registry.npmjs.org/file-type/-/file-type-18.7.0.tgz", - "integrity": "sha512-ihHtXRzXEziMrQ56VSgU7wkxh55iNchFkosu7Y9/S+tXHdKyrGjVK0ujbqNnsxzea+78MaLhN6PGmfYSAv1ACw==", + "version": "19.0.0", + "resolved": "https://registry.npmjs.org/file-type/-/file-type-19.0.0.tgz", + "integrity": "sha512-s7cxa7/leUWLiXO78DVVfBVse+milos9FitauDLG1pI7lNaJ2+5lzPnr2N24ym+84HVwJL6hVuGfgVE+ALvU8Q==", "dependencies": { "readable-web-to-node-stream": "^3.0.2", "strtok3": "^7.0.0", "token-types": "^5.0.1" }, "engines": { - "node": ">=14.16" + "node": ">=18" }, "funding": { "url": "https://github.com/sindresorhus/file-type?sponsor=1" diff --git a/package.json b/package.json index e3b5d38acb..eacaecf2d4 100644 --- a/package.json +++ b/package.json @@ -257,7 +257,7 @@ "express-rate-limit": "7.0.0", "express-timeout-handler": "^2.2.2", "fastest-levenshtein": "1.0.16", - "file-type": "18.7.0", + "file-type": "19.0.0", "flat": "^6.0.1", "github-slugger": "^2.0.0", "glob": "10.0.0",