Skip to content

Commit 127f81f

Browse files
isaacmbrownboylejj
andauthored
[2024-04-12] Deprecate non-Git options for GitHub Importer (#44048)
Co-authored-by: Jim Boyle <[email protected]>
1 parent 78a8760 commit 127f81f

File tree

9 files changed

+28
-95
lines changed

9 files changed

+28
-95
lines changed

content/migrations/importing-source-code/using-github-importer/about-github-importer.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,34 @@
11
---
22
title: About GitHub Importer
3-
intro: "If your source code is stored on a code hosting service using Git, Subversion, Mercurial, or Team Foundation Version Control (TFVC) and is accessible from the public internet, you can move the code to {% data variables.product.prodname_dotcom %} using {% data variables.product.prodname_importer %}."
3+
intro: "If your source code is stored on another Git-based hosting service, you can move the code to {% data variables.product.prodname_dotcom %} using {% data variables.product.prodname_importer %}."
44
redirect_from:
55
- /articles/about-github-importer
66
- /github/importing-your-projects-to-github/about-github-importer
77
- /github/importing-your-projects-to-github/importing-source-code-to-github/about-github-importer
88
- /get-started/importing-your-projects-to-github/importing-source-code-to-github/about-github-importer
9+
- /articles/updating-commit-author-attribution-with-github-importer
10+
- /github/importing-your-projects-to-github/updating-commit-author-attribution-with-github-importer
11+
- /github/importing-your-projects-to-github/importing-source-code-to-github/updating-commit-author-attribution-with-github-importer
12+
- /get-started/importing-your-projects-to-github/importing-source-code-to-github/updating-commit-author-attribution-with-github-importer
13+
- /migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer
914
versions:
1015
fpt: '*'
1116
ghec: '*'
1217
---
1318

1419
## About {% data variables.product.prodname_importer %}
1520

16-
{% data variables.product.prodname_importer %} is a tool that quickly imports source code repositories, including commits and revision history, to {% data variables.product.prodname_dotcom_the_website %} for you.
21+
{% data variables.product.prodname_importer %} is a tool that quickly imports Git repositories from other hosting services to {% data variables.product.prodname_dotcom %}.
1722

18-
During an import, depending on the version control system you're importing from, you can authenticate with your remote repository, update commit author attribution, and either import repositories with large files or, if you don't want to use {% data variables.large_files.product_name_long %}, remove large files.
23+
To get started with {% data variables.product.prodname_importer %}, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer#importing-a-repository-with-github-importer)."
1924

20-
## Supported functionality by version control system
25+
## Capabilities and limitations of {% data variables.product.prodname_importer %}
2126

22-
{% data reusables.migrations.github-importer-non-git-deprecation %}
23-
24-
{% rowheaders %}
25-
26-
| Import action | Subversion | Mercurial | TFVC | Git |
27-
|:--------------|:----------:|:---------:|:----------------------:|:---:|
28-
| Authenticate with remote repository | {% octicon "check" aria-label="Supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
29-
| [Update commit author attribution](/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer) | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
30-
| Move large files to [Git Large File Storage](/repositories/working-with-files/managing-large-files/about-git-large-file-storage) | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
31-
| Remove large files from your repository | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
32-
33-
{% endrowheaders %}
27+
- {% data variables.product.prodname_importer %} imports the source code and commit history of a repository. It does not import other associated data from the hosting service, such as issues and pull requests.
28+
- During an import, you can authenticate with your remote repository. The repository must be accessible from the public internet. If the repository is hosted on a private network, {% data variables.product.prodname_importer %} won't be able to access it.
29+
- {% data variables.product.prodname_importer %} does not support repositories that use version control systems other than Git, such as Mercurial, Subversion, or Team Foundation Version Control (TFVC). For more information about alternatives to {% data variables.product.prodname_importer %}, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line)."
30+
- Repositories and individual files on {% data variables.product.prodname_dotcom %} are subject to size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)."
31+
- {% data variables.product.prodname_importer %} does not move Git Large File Storage (LFS) objects from the source repository to the target repository. If you use Git LFS, you will need to either convert the Git LFS objects to regular files tracked by Git before running the migration, or move the Git LFS objects to the new repository separately after running the migration.
3432

3533
## Further reading
3634

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Importing a repository with GitHub Importer
3-
intro: 'If you have a project hosted on another version control system, you can automatically import it to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool.'
3+
intro: 'If you have a project hosted on another Git-based hosting service, you can quickly import it to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool.'
44
redirect_from:
55
- /articles/importing-from-other-version-control-systems-to-github
66
- /articles/importing-a-repository-with-github-importer
@@ -15,15 +15,9 @@ shortTitle: Import a repository
1515

1616
## About repository imports with {% data variables.product.prodname_importer %}
1717

18-
{% data variables.product.prodname_importer %} is not suitable for all imports. For example, if your existing code is hosted on a private network, our tool won't be able to access it. In these cases, we recommend [importing using the command line](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line) for Git repositories or an external [source code migration tool](/migrations/importing-source-code/using-the-command-line-to-import-source-code) for projects imported from other version control systems.
18+
{% data variables.product.prodname_importer %} imports the source code and commit history of Git repositories hosted on external hosting services. For more information about the capabilities and limitations of {% data variables.product.prodname_importer %}, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer#capabilities-and-limitations-of-github-importer)."
1919

20-
{% data reusables.migrations.github-importer-non-git-deprecation %}
21-
22-
If you'd like to match the commits in your repository to the authors' {% data variables.product.prodname_dotcom %} personal accounts during the import, make sure every contributor to your repository has a {% data variables.product.prodname_dotcom %} account before you begin the import.
23-
24-
{% data reusables.repositories.repo-size-limit %}
25-
26-
For more information about migration paths to {% data variables.product.prodname_dotcom %} from other products, or between {% data variables.product.prodname_dotcom %} products, see "[AUTOTITLE](/migrations/overview/migration-paths-to-github)."
20+
{% data variables.product.product_name %} uses the email address in the commit header to link a commit to a {% data variables.product.prodname_dotcom %} user. To correctly attribute commits in an imported repository, users will need to add the email address associated with their commits to their account on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)."
2721

2822
## Importing a repository with {% data variables.product.prodname_importer %}
2923

@@ -33,14 +27,10 @@ When you import a repository using the {% data variables.product.prodname_import
3327

3428
![Screenshot of the top-right corner of any page on {% data variables.product.prodname_dotcom %}. A plus icon is highlighted with an orange outline.](/assets/images/help/importer/import-repository.png)
3529

36-
1. Under "Your old repository's clone URL", type the URL of the project you want to import.
37-
1. Under "Owner", select the dropdown menu and click your personal account or an organization to own the repository
38-
1. Under "Name", type a name for the repository on {% data variables.product.prodname_dotcom %}.
39-
1. Under "Privacy", select a visibility for the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)."
40-
1. Review the information you entered, then click **Begin import**.
41-
1. If your old project requires credentials, type your login information for that project. If SAML SSO or 2FA are enabled for your user account on the old project, enter a {% data variables.product.pat_generic %} with repository read permissions in the "Password" field instead of your password.
42-
1. Click **Submit**.
43-
1. If there are multiple projects hosted at your old project's clone URL, select the project you'd like to import, then click **Submit**.
44-
1. If you're moving from a version control system other than Git and your project contains files larger than 100 MB, select whether to import the large files using [Git Large File Storage](/repositories/working-with-files/managing-large-files), then click **Continue**.
45-
46-
You'll receive an email when the repository has been completely imported.
30+
1. On the "Import your project to {% data variables.product.prodname_dotcom %}" page, enter the URL for the remote repository hosted on another platform.
31+
1. If the source repository is private, enter credentials for authentication. {% data variables.product.prodname_importer %} will use the credentials to perform a `git clone` operation on the source repository.
32+
1. Choose an owner and a name for the new repository on {% data variables.product.prodname_dotcom %}.
33+
1. Choose the visibility of the new repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)."
34+
1. Click **Begin import**.
35+
36+
You'll be redirected to a "Preparing your new repository" page, where you can track the status of your import. You'll receive an email when the repository has been completely imported.

content/migrations/importing-source-code/using-github-importer/index.md

-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,5 @@ versions:
99
children:
1010
- /about-github-importer
1111
- /importing-a-repository-with-github-importer
12-
- /updating-commit-author-attribution-with-github-importer
1312
shortTitle: GitHub Importer
1413
---

content/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer.md

-41
This file was deleted.

content/migrations/overview/programmatically-importing-repositories.md

-6
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@ To learn more about "source and history" and other types of migrations, see "[AU
1515

1616
The term "source repository" refers to the repository you're importing, and "imported repository" refers to the new repository you're creating.
1717

18-
### About the deprecation of the Source imports REST API
19-
20-
The REST API endpoints to manage source imports allowed the programmatic import of a repositories that are accessible over the internet to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/rest/migrations/source-imports)."
21-
22-
On April 12, 2024, {% data variables.product.company_short %} will deprecate all of the endpoints listed within "[AUTOTITLE](/rest/migrations/source-imports)." If you currently use these operations, you'll need to make changes to your code or your application will stop working on April 12, 2024.
23-
2418
## Using forks
2519

2620
If the source repository is on {% data variables.product.prodname_dotcom_the_website %}, you may be able to use a fork instead of importing the repository. {% data reusables.repositories.about-forks %} For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)."

content/repositories/creating-and-managing-repositories/duplicating-a-repository.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ topics:
1717

1818
{% note %}
1919

20-
**Note:** If you have a project hosted on another version control system, you can automatically import your project to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer)."
20+
**Note:** If you have a project hosted on another Git-based hosting service, you can automatically import your project to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer)."
2121

2222
{% endnote %}
2323

content/rest/migrations/source-imports.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: REST API endpoints for source imports
33
shortTitle: Source endpoints
44
allowTitleToDifferFromFilename: true
55
intro: >-
6-
Use the REST API to start an import from a Git, Subversion, Mercurial, or Team
7-
Foundation Version Control source repository.
6+
Use the REST API to start an import from a Git source repository.
87
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
98
fpt: '*'
109
ghec: '*'
@@ -17,7 +16,7 @@ autogenerated: rest
1716

1817
{% warning %}
1918

20-
**Warning**: Due to very low levels of usage and available alternatives, the Source Imports API is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
19+
**Warning**: Due to very low levels of usage and available alternatives, the Source Imports API has been deprecated and is no longer available as of April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
2120

2221
{% endwarning %}
2322

data/reusables/migrations/github-importer-non-git-deprecation.md

-5
This file was deleted.

data/variables/migrations.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ user_migrations_intro: >-
33
organization_migrations_intro: >-
44
You can use these endpoints to export one or more repositories so you can move them to a{% ifversion ghes %}nother{% endif %} {% data variables.product.prodname_ghe_server %} instance. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom)."
55
source_imports_intro: >-
6-
You can use these endpoints to start an import from a Git, Subversion,
7-
Mercurial, or Team Foundation Version Control source repository. This is the same
6+
You can use these endpoints to start an import from a Git repository hosted with another service. This is the same
87
functionality as the {% data variables.product.prodname_dotcom %}
98
Importer. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer)."

0 commit comments

Comments
 (0)