Skip to content

Commit c91a952

Browse files
authored
Update README.md
1 parent 5740b8c commit c91a952

1 file changed

Lines changed: 23 additions & 15 deletions

File tree

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ IAM User who owns these credential must have [write permissions](https://docs.aw
8888

8989
Existing bucket, with an appropriate security policy. One possible policy is to allow [public access](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteAccessPermissionsReqd.html).
9090

91+
### usermap
92+
93+
Maps the usernames from gitlab to github. If the assinee of the gitlab issue is equal to the one currently logged in github it will also get assigned without a usermap. The Mentions in issues will also be translated to the new github name.
94+
95+
### projectmap
96+
97+
When one renames the project while transfering so that the projects don't loose there links to the mentioned issues.
98+
99+
### conversion
100+
101+
#### conversion.useLowerCaseLabels
102+
103+
If this is set to true (default) then labels from GitLab will be converted to lowercase in GitHub.
104+
105+
### transfer
106+
91107
#### transfer.milestones
92108

93109
If this is set to true (default) then the migration process will transfer milestones.
@@ -104,30 +120,30 @@ If this is set to true (default) then the migration process will transfer issues
104120

105121
If this is set to true (default) then the migration process will transfer merge requests.
106122

107-
#### debug
123+
### debug
108124

109125
As default it is set to false. Doesn't fire the requests to github api and only does the work on the gitlab side to test for wonky cases before using up api-calls
110126

111-
#### usePlaceholderIssuesForMissingIssues
127+
### usePlaceholderIssuesForMissingIssues
112128

113129
If this is set to true (default) then the migration process will automatically create empty dummy issues for every 'missing' GitLab issue (if you deleted an GitLab issue for example). Those issues will be closed on Github and they ensure, that the issue ids stay the same on both, GitLab and Github.
114130

115-
#### useReplacementIssuesForCreationFails
131+
### useReplacementIssuesForCreationFails
116132

117133
If this is set to true (default) then the migration process will automatically create so called "replacement-issues" for every issue where the migration fails. This replacement issue will be exactly the same, but the original description will be lost. In the future, the description of the replacement issue will also contain a link to the original issue on GitLab. This way users, who still have access to the GitLab repository can still view its content. However, this is still an open task. (TODO)
118134

119135
It would of course be better to find the cause for migration fails, so that no replacement issues would be needed. Finding the cause together with a retry-mechanism would be optimal, and will maybe come in the future - currently the replacement-issue-mechanism helps to keep things in order.
120136

121-
#### useIssuesForAllMergeRequests
137+
### useIssuesForAllMergeRequests
122138

123139
If this is set to true (default is false) then all merge requests will be migrated as GitHub issues (rather than pull requests). This can be
124140
used to sidestep the problem where pull requests are rejected by GitHub if the feature branch no longer exists or has been merged.
125141

126-
#### filterByLabel
142+
### filterByLabel
127143

128144
Filters all merge requests and issues by these labels. The applicable values can be found in the Gitlab API documentation for [issues](https://docs.gitlab.com/ee/api/issues.html#list-project-issues) and [merge requests](https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests) respectively. Default is `null` which returns all issues/merge requests.
129145

130-
#### skipMatchingComments
146+
### skipMatchingComments
131147

132148
This is an array (empty per default) that may contain string values. Any note/comment in any issue, that contains one or more of those string values, will be skipped (meaining not migrated). Note that this is case insensitive, therefore the string value `foo` would also lead to skipping notes containing a (sub)string `FOO`.
133149

@@ -136,18 +152,10 @@ Suggested values:
136152
- `time spent`, since those kind of terms can be used in GitLab to track time, they are rather meaningless in Github though
137153
- action entries, such as `changed the description`, `added 1 commit`, `mentioned in merge request`, etc as they are interpreted as comments
138154

139-
#### mergeRequests
155+
### mergeRequests
140156

141157
Object consisting of `logfile` and `log`. If `log` is set to true, then the merge requests are logged in the specified file and not migrated. Conversely, if `log` is set to false, then the merge requests are migrated to GitHub and not logged. If the source or target branches linked to the merge request have been deleted, the merge request cannot be migrated to a pull request; instead, an issue with a custom "gitlab merge request" tag is created with the full comment history of the merge request.
142158

143-
### usermap
144-
145-
Maps the usernames from gitlab to github. If the assinee of the gitlab issue is equal to the one currently logged in github it will also get assigned without a usermap. The Mentions in issues will also be translated to the new github name.
146-
147-
### projectmap
148-
149-
When one renames the project while transfering so that the projects don't loose there links to the mentioned issues.
150-
151159
## Import limit
152160

153161
Because Github has a limit of 5000 Api requests per hour one has to watch out that one doesn't get over this limit. I transferred one of my project with it ~ 300 issues with ~ 200 notes. This totals to some 500 objects excluding commits which are imported through githubs importer. I never got under 3800 remaining requests (while testing it two times in one hour).

0 commit comments

Comments
 (0)