From b42b3796aec4c5d8ad82c1e5bf7c9b91efe0a7cc Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Thu, 5 Jul 2018 17:30:22 +0300 Subject: Add documentation for manifest import feature Signed-off-by: Dmitriy Zaporozhets --- doc/api/settings.md | 2 +- doc/user/project/import/img/manifest_status.png | Bin 0 -> 34878 bytes doc/user/project/import/img/manifest_upload.png | Bin 0 -> 17455 bytes doc/user/project/import/index.md | 1 + doc/user/project/import/manifest.md | 44 ++++++++++++++++++++++++ 5 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 doc/user/project/import/img/manifest_status.png create mode 100644 doc/user/project/import/img/manifest_upload.png create mode 100644 doc/user/project/import/manifest.md (limited to 'doc') diff --git a/doc/api/settings.md b/doc/api/settings.md index e6b207d8746..b6f2101fc7b 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -105,7 +105,7 @@ PUT /application/settings | `housekeeping_gc_period` | integer | no | Number of Git pushes after which 'git gc' is run. | | `housekeeping_incremental_repack_period` | integer | no | Number of Git pushes after which an incremental 'git repack' is run. | | `html_emails_enabled` | boolean | no | Enable HTML emails | -| `import_sources` | Array of strings | no | Sources to allow project import from, possible values: "github bitbucket gitlab google_code fogbugz git gitlab_project | +| `import_sources` | Array of strings | no | Sources to allow project import from, possible values: "github bitbucket gitlab google_code fogbugz git gitlab_project manifest | | `koding_enabled` | boolean | no | Enable Koding integration. Default is `false`. | | `koding_url` | string | yes (if `koding_enabled` is `true`) | The Koding instance URL for integration. | | `max_artifacts_size` | integer | no | Maximum artifacts size in MB | diff --git a/doc/user/project/import/img/manifest_status.png b/doc/user/project/import/img/manifest_status.png new file mode 100644 index 00000000000..b706116a2ac Binary files /dev/null and b/doc/user/project/import/img/manifest_status.png differ diff --git a/doc/user/project/import/img/manifest_upload.png b/doc/user/project/import/img/manifest_upload.png new file mode 100644 index 00000000000..385df3aa8ce Binary files /dev/null and b/doc/user/project/import/img/manifest_upload.png differ diff --git a/doc/user/project/import/index.md b/doc/user/project/import/index.md index 72cc58546b7..b55435e5b4f 100644 --- a/doc/user/project/import/index.md +++ b/doc/user/project/import/index.md @@ -11,6 +11,7 @@ 1. [From SVN](svn.md) 1. [From TFS](tfs.md) 1. [From repo by URL](repo_by_url.md) +1. [By uploading a manifest file](manifest.md) In addition to the specific migration documentation above, you can import any Git repository via HTTP from the New Project page. Be aware that if the diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md new file mode 100644 index 00000000000..16c7e77d033 --- /dev/null +++ b/doc/user/project/import/manifest.md @@ -0,0 +1,44 @@ +# Import multiple repositories by uploading a manifest file + +GitLab allows you to import all the required git repositories based on the +Android repository manifest file. + +You can do it by following next steps: + +1. From your GitLab dashboard click **New project** +1. Switch to the **Import project** tab +1. Click on the **Manifest file** button +1. Provide GitLab with a manifest xml file +1. Select a group you want to import to (you need to create a group first if you don't have one) +1. Click **Import projects** +1. You will be redirected to the import status page with projects list based on manifest file +1. Check the list and click 'Import all repositories' to start import. + +![Manifest upload](img/manifest_upload.png) + +![Manifest status](img/manifest_status.png) + +### Manifest format + +A manifest must be an XML file. There must be one `remote` tag with `review` attribute +that contains a URL to a git server. Each `project` tag must have `name` and `path` attribute. +GitLab will build URL to the repository by combining URL from `remote` tag with a project name. +A path attribute will be used to represent project path in GitLab system. + +Below is a valid example of manifest file. + +```xml + + + + + + +``` + +As result next projects will be created: + +| GitLab | Import URL | +|---|---| +| https://gitlab/YOUR_GROUP/build/make | https://android-review.googlesource.com/platform/build | +| https://gitlab/YOUR_GROUP/build/blueprint | https://android-review.googlesource.com/platform/build/blueprint | -- cgit v1.2.1 From a4b6707e63ca10eb64a92d45797eaad49e9c9f46 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Fri, 6 Jul 2018 16:21:22 +0300 Subject: Refactor manifest import code Signed-off-by: Dmitriy Zaporozhets --- doc/user/project/import/img/manifest_upload.png | Bin 17455 -> 11595 bytes doc/user/project/import/manifest.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user/project/import/img/manifest_upload.png b/doc/user/project/import/img/manifest_upload.png index 385df3aa8ce..ea68e7ffc6a 100644 Binary files a/doc/user/project/import/img/manifest_upload.png and b/doc/user/project/import/img/manifest_upload.png differ diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md index 16c7e77d033..136ba310da1 100644 --- a/doc/user/project/import/manifest.md +++ b/doc/user/project/import/manifest.md @@ -10,7 +10,7 @@ You can do it by following next steps: 1. Click on the **Manifest file** button 1. Provide GitLab with a manifest xml file 1. Select a group you want to import to (you need to create a group first if you don't have one) -1. Click **Import projects** +1. Click **Continue to the next step** 1. You will be redirected to the import status page with projects list based on manifest file 1. Check the list and click 'Import all repositories' to start import. -- cgit v1.2.1 From 97751ca19ff48b50de4887d5c77df3488c04b759 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Mon, 9 Jul 2018 10:55:10 +0300 Subject: Rename button at manifest import form Signed-off-by: Dmitriy Zaporozhets --- doc/user/project/import/img/manifest_upload.png | Bin 11595 -> 11940 bytes doc/user/project/import/manifest.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user/project/import/img/manifest_upload.png b/doc/user/project/import/img/manifest_upload.png index ea68e7ffc6a..1925c3349ed 100644 Binary files a/doc/user/project/import/img/manifest_upload.png and b/doc/user/project/import/img/manifest_upload.png differ diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md index 136ba310da1..5ec64225098 100644 --- a/doc/user/project/import/manifest.md +++ b/doc/user/project/import/manifest.md @@ -10,7 +10,7 @@ You can do it by following next steps: 1. Click on the **Manifest file** button 1. Provide GitLab with a manifest xml file 1. Select a group you want to import to (you need to create a group first if you don't have one) -1. Click **Continue to the next step** +1. Click **List available repositories** 1. You will be redirected to the import status page with projects list based on manifest file 1. Check the list and click 'Import all repositories' to start import. -- cgit v1.2.1 From 6743147b7d9f310fbf5afa520e19ae495fd4df33 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Mon, 9 Jul 2018 14:59:07 +0300 Subject: Improve manifest feature after backend review Signed-off-by: Dmitriy Zaporozhets --- doc/user/project/import/img/manifest_upload.png | Bin 11940 -> 12079 bytes doc/user/project/import/manifest.md | 8 ++++++-- 2 files changed, 6 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/user/project/import/img/manifest_upload.png b/doc/user/project/import/img/manifest_upload.png index 1925c3349ed..d6bf4b157dd 100644 Binary files a/doc/user/project/import/img/manifest_upload.png and b/doc/user/project/import/img/manifest_upload.png differ diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md index 5ec64225098..2233a310bc7 100644 --- a/doc/user/project/import/manifest.md +++ b/doc/user/project/import/manifest.md @@ -1,7 +1,11 @@ # Import multiple repositories by uploading a manifest file -GitLab allows you to import all the required git repositories based on the -Android repository manifest file. +GitLab allows you to import all the required git repositories +based a manifest file like the one used by the Android repository. + + +>**Note:** +This feature requires [subgroups](user/group/subgroups/index.md) to be supported by your database. You can do it by following next steps: -- cgit v1.2.1 From ac07634efacae0a7199c70e26a98c2d9e26f52fe Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Mon, 9 Jul 2018 20:29:28 +0300 Subject: Fix a link to subgroup doc from manifest doc Signed-off-by: Dmitriy Zaporozhets --- doc/user/project/import/manifest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user/project/import/manifest.md b/doc/user/project/import/manifest.md index 2233a310bc7..812ecf05faf 100644 --- a/doc/user/project/import/manifest.md +++ b/doc/user/project/import/manifest.md @@ -5,7 +5,7 @@ based a manifest file like the one used by the Android repository. >**Note:** -This feature requires [subgroups](user/group/subgroups/index.md) to be supported by your database. +This feature requires [subgroups](../../group/subgroups/index.md) to be supported by your database. You can do it by following next steps: -- cgit v1.2.1