This version of GitHub Enterprise will be discontinued on This version of GitHub Enterprise was discontinued on 2020-08-20. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Article version: Enterprise Server 2.18

Reviewing migration data

After every step of a migration you can review the state of the migration data. You'll be able to ensure records are being mapped or renamed properly, get the new urls for records after the import step, as well as list out any records that failed to migrate.

In this article

By default, ghe-migrator audit returns every record. It also allows you to filter records by:

  • The types of records.
  • The state of the records.

The record types match those found in the migrated data.

Record type filters

Record typeFilter name
Usersuser
Organizationsorganization
Repositoriesrepository
Teamsteam
Milestonesmilestone
Project boardsproject
Issuesissue
Issue commentsissue_comment
Pull requestspull_request
Pull request reviewspull_request_review
Commit commentscommit_comment
Pull request review commentspull_request_review_comment
Releasesrelease
Actions taken on pull requests or issuesissue_event
Protected branchesprotected_branch

Record state filters

Record stateDescription
exportThe record will be exported.
importThe record will be imported.
mapThe record will be mapped.
renameThe record will be renamed.
mergeThe record will be merged.
exportedThe record was successfully exported.
importedThe record was successfully imported.
mappedThe record was successfully mapped.
renamedThe record was successfully renamed.
mergedThe record was successfully merged.
failed_exportThe record failed to export.
failed_importThe record failed to be imported.
failed_mapThe record failed to be mapped.
failed_renameThe record failed to be renamed.
failed_mergeThe record failed to be merged.

Filtering audited records

With the ghe-migrator audit command, you can filter based on the record type using the -m flag. Similarly, you can filter on the import state using the -s flag. The command looks like this:

$ ghe-migrator audit -m RECORD_TYPE -s STATE -g MIGRATION_GUID

For example, to view every successfully imported organization and team, you would enter:

$ ghe-migrator audit -m organization,team -s mapped,renamed -g MIGRATION_GUID
> model_name,source_url,target_url,state
> organization,https://gh.source/octo-org/,https://ghe.target/octo-org/,renamed

We strongly recommend auditing every import that failed. To do that, you will enter:

$ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g MIGRATION_GUID
> model_name,source_url,target_url,state
> user,https://gh.source/octocat,https://gh.target/octocat,failed
> repository,https://gh.source/octo-org/octo-project,https://ghe.target/octo-org/octo-project,failed

If you have any concerns about failed imports, contact GitHub Enterprise Support or GitHub Premium Support.

Ask a human

Can't find what you're looking for?

Contact us