git.marmaro.de Git - mantis2gitlab/blob - README.md

   1 # YouTrack2GitLab
   2 Import YouTrack issues into GitLab.
   3
   4 ## Install
   5
   6 ```
   7 npm install -g youtrack2gitlab
   8 ```
   9
  10 ## Usage
  11
  12 ```
  13 yt2gl -i <input> -u <users> -g <gitlaburl> -p <project> -t <token>
  14 ```
  15
  16 ## Options
  17
  18 ```
  19 -i, --input
  20  CSV file exported from YouTrack (Example: issues.csv)
  21
  22 -u, --users
  23  User mapping file (Example: users.json)
  24
  25 -g, --gitlaburl
  26  GitLab URL hostname (Example: gitlab.example.com)
  27
  28 -p, --project
  29  GitLab project name including namespace (Example: mycorp/myproj)
  30
  31 -t, --token
  32  An admin user's private token (Example: a2r33oczFyQzq53t23Vj)
  33 ```
  34
  35 ## User Mapping File
  36 In order to correctly map users you should create a JSON file with the following format and specify it with the **-u** switch:
  37
  38 ```
  39 [
  40   {
  41     "yt_username": "USER'S USERNAME IN YOUTRACK",
  42     "yt_name": "USER'S NAME IN YOUTRACK",
  43     "gl_username": "USER'S USERNAME IN GITLAB",
  44     "gl_private_token": "USER'S PRIVATE TOKEN IN GITLAB"
  45   },
  46   …
  47 ]
  48 ```
  49
  50 ## Notes
  51 - Make sure the input CSV file only includes issues for the project you want to import.
  52 - Make sure that all users have write access to the specified repository or some issues will fail to import. A safer approach is to set repository's **Visibility Level** to **Public** and revert it when the import process is complete.
  53 - In version 6.4.3, GitLab API does not support setting creation date of issues. So all imported issues will have a creation time of now.
  54 - In version 6.4.3, GitLab API fails to import issues with very long titles.
  55 - In version 6.4.3, GitLab does not allow issues to be deleted. So be careful when importing issues into an active project.
  56 - Milestones are not currently supported.
  57
  58 ## Version History
  59 + **1.0**
  60         + Initial release
  61
  62 ## Author
  63 **Soheil Rashidi**
  64
  65 + http://soheilrashidi.com
  66 + http://twitter.com/soheilpro
  67 + http://github.com/soheilpro
  68
  69 ## Copyright and License
  70 Copyright 2014 Soheil Rashidi
  71
  72 Licensed under the The MIT License (the "License");
  73 you may not use this work except in compliance with the License.
  74 You may obtain a copy of the License in the LICENSE file, or at:
  75
  76 http://www.opensource.org/licenses/mit-license.php
  77
  78 Unless required by applicable law or agreed to in writing, software
  79 distributed under the License is distributed on an "AS IS" BASIS,
  80 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  81 See the License for the specific language governing permissions and
  82 limitations under the License.