49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
---
|
|
stage: Systems
|
|
group: Distribution
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# GitHub import **(FREE SELF)**
|
|
|
|
To retrieve and import GitHub repositories, you need a [GitHub personal access token](https://github.com/settings/tokens).
|
|
A username should be passed as the second argument to the Rake task,
|
|
which becomes the owner of the project. You can resume an import
|
|
with the same command.
|
|
|
|
Bear in mind that the syntax is very specific. Remove any spaces in the argument block and
|
|
before/after the brackets. Also, some shells (for example, Zsh) can interpret the open/close brackets
|
|
(`[]`) separately. You may want to either escape the brackets or use double quotes.
|
|
|
|
## Caveats
|
|
|
|
If the GitHub [rate limit](https://docs.github.com/en/rest/rate-limit) is reached while
|
|
importing, the importing process waits (`sleep()`) until it can continue importing.
|
|
|
|
## Importing multiple projects
|
|
|
|
To import a project from the list of your GitHub projects available:
|
|
|
|
```shell
|
|
# Omnibus installations
|
|
sudo gitlab-rake "import:github[access_token,root,foo/bar]"
|
|
|
|
# Installations from source
|
|
bundle exec rake "import:github[access_token,root,foo/bar]" RAILS_ENV=production
|
|
```
|
|
|
|
In this case, `access_token` is your GitHub personal access token, `root`
|
|
is your GitLab username, and `foo/bar` is the new GitLab namespace/project
|
|
created from your GitHub project. Subgroups are also possible: `foo/foo/bar`.
|
|
|
|
## Importing a single project
|
|
|
|
To import a specific GitHub project (named `foo/github_repo` here):
|
|
|
|
```shell
|
|
# Omnibus installations
|
|
sudo gitlab-rake "import:github[access_token,root,foo/bar,foo/github_repo]"
|
|
|
|
# Installations from source
|
|
bundle exec rake "import:github[access_token,root,foo/bar,foo/github_repo]" RAILS_ENV=production
|
|
```
|