source_imports

Overview

Name	source_imports
Type	Resource
Id	github.migrations.source_imports

Fields

Name	Datatype	Description
authors_count	integer
authors_url	string
commit_count	integer
error_message	string
failed_step	string
has_large_files	boolean
html_url	string
import_percent	integer
large_files_count	integer
large_files_size	integer
message	string
project_choices	array
push_percent	integer
repository_url	string
status	string
status_text	string
svc_root	string
svn_root	string
tfvc_project	string
url	string
use_lfs	boolean
vcs	string
vcs_url	string	The URL of the originating repository.

Methods

Name	Accessible by	Required Params	Description
get_import_status	SELECT	owner, repo	View the progress of an import. Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. Import status This section includes details about the possible values of the status field of the Import Progress response. An import that does not have errors will progress through these steps: detecting - the "detection" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL. importing - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import). mapping - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. pushing - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is "Writing objects". complete - the import is complete, and the repository is ready on GitHub. If there are problems, you will see one of these in the status field: auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section. error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information. detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section. detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL. detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section. The project_choices field When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. Git LFS related fields This section includes details about Git LFS related fields that may be present in the Import Progress response. use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken. has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step. large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository. large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
cancel_import	EXEC	owner, repo	Stop an import for a repository. Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
start_import	EXEC	owner, repo, data__vcs_url	Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response. Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
update_import	EXEC	owner, repo	An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted. Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status detection_found_multiple and the Import Progress response will include a project_choices array. You can select the project to import by providing one of the objects in the project_choices array in the update request. Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.