Skip to content

Commit 83a7567

Browse files
committed
Mark boolean values consistently as code element
1 parent 029b8fb commit 83a7567

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Leave it null for the first run of the script. Then the script will show you whi
8686

8787
#### gitlab.listArchivedProjects
8888

89-
When listing projects on the first run (projectID = null), include archived ones too. The default is *true*.
89+
When listing projects on the first run (projectID = null), include archived ones too. The default is `true`.
9090

9191
#### gitlab.sessionCookie
9292

@@ -108,25 +108,25 @@ Under which organisation or user will the new project be hosted
108108

109109
#### github.ownerIsOrg
110110

111-
A boolean indicator (default is *false*) to specify that the owner of this repo is an Organisation.
111+
A boolean indicator (default is `false`) to specify that the owner of this repo is an Organisation.
112112

113113
#### github.token
114114

115115
Go to [Settings / Developer settings / Personal access tokens](https://github.com/settings/tokens). Generate a new token with `repo` scope and copy that into the `settings.ts`
116116

117117
#### github.token_owner
118118

119-
Set to the user name of the user whose token is used (see above). This is required to determine whether the user running the migration is also the creator of comments and issues. If this is the case and `useIssueCreationAPI` is true (see below), the extra line specifying who created a comment or issue will not be added.
119+
Set to the user name of the user whose token is used (see above). This is required to determine whether the user running the migration is also the creator of comments and issues. If this is the case and `useIssueCreationAPI` is `true` (see below), the extra line specifying who created a comment or issue will not be added.
120120

121121
#### github.repo
122122

123123
What is the name of the new repo
124124

125125
#### github.recreateRepo
126126

127-
If true (default is false), we will try to delete the destination github repository if present, and (re)create it. The github token must be granted `delete_repo` scope. The newly created repository will be made private by default.
127+
If `true` (default is `false`), we will try to delete the destination github repository if present, and (re)create it. The github token must be granted `delete_repo` scope. The newly created repository will be made private by default.
128128

129-
If you've set `github.recreateRepo` to true and the repo belongs to an Organisation, the `github.ownerIsOrg` flag **must** be set as true.
129+
If you've set `github.recreateRepo` to `true` and the repo belongs to an Organisation, the `github.ownerIsOrg` flag **must** be set as `true`.
130130

131131
This is useful when debugging this tool or a specific migration. You will always be prompted for confirmation.
132132

@@ -160,7 +160,7 @@ When one renames the project while transfering so that the projects don't loose
160160

161161
#### conversion.useLowerCaseLabels
162162

163-
If this is set to true (default) then labels from GitLab will be converted to lowercase in GitHub.
163+
If this is set to `true` (default) then labels from GitLab will be converted to lowercase in GitHub.
164164

165165
#### conversion.addIssueInformation
166166

@@ -170,57 +170,57 @@ If this is set to `true` (default) then issues and pull requests will get inform
170170

171171
#### transfer.milestones
172172

173-
If this is set to true (default) then the migration process will transfer milestones.
173+
If this is set to `true` (default) then the migration process will transfer milestones.
174174

175175
#### transfer.labels
176176

177-
If this is set to true (default) then the migration process will transfer labels.
177+
If this is set to `true` (default) then the migration process will transfer labels.
178178

179179
#### transfer.issues
180180

181-
If this is set to true (default) then the migration process will transfer issues.
181+
If this is set to `true` (default) then the migration process will transfer issues.
182182

183183
#### transfer.mergeRequests
184184

185-
If this is set to true (default) then the migration process will transfer merge requests.
185+
If this is set to `true` (default) then the migration process will transfer merge requests.
186186

187187
#### transfer.releases
188188

189-
If this is set to true (default) then the migration process will transfer releases.
189+
If this is set to `true` (default) then the migration process will transfer releases.
190190
Note that github api for releases is limited and hence this will only transfer the title and description of the releases
191191
and add them to github in chronological order, but it would not preserve the original release dates, nor transfer artefacts or assets.
192192

193193
### dryRun
194194

195-
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
195+
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
196196

197197
### exportUsers
198198

199-
If this is set to true (default is false) then a file called "users.txt" wil be created containing all
199+
If this is set to `true` (default is `false`) then a file called "users.txt" wil be created containing all
200200
usernames that contributed to the repository. You can use this with dryRun when you need to map users
201201
for the migration, but you do not know all the source usernames.
202202

203203
### useIssueImportAPI
204204

205-
Set to true (default) to enable using the [GitHub preview API for importing issues](https://gist.github.com/jonmagic/5282384165e0f86ef105). This allows setting the date for issues and comments instead of inserting an additional line in the body.
205+
Set to `true` (default) to enable using the [GitHub preview API for importing issues](https://gist.github.com/jonmagic/5282384165e0f86ef105). This allows setting the date for issues and comments instead of inserting an additional line in the body.
206206

207207
### usePlaceholderIssuesForMissingIssues
208208

209-
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 a 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.
209+
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 a 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.
210210

211211
#### usePlaceholderMilestonesForMissingMilestones
212212

213-
If this is set to true (default) then the migration process will automatically create empty dummy milestones for every 'missing' GitLab milestone (if you deleted a GitLab milestone for example). Those milestones will be closed on Github and they ensure that the milestone ids stay the same on both GitLab and Github.
213+
If this is set to `true` (default) then the migration process will automatically create empty dummy milestones for every 'missing' GitLab milestone (if you deleted a GitLab milestone for example). Those milestones will be closed on Github and they ensure that the milestone ids stay the same on both GitLab and Github.
214214

215215
#### useReplacementIssuesForCreationFails
216216

217-
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)
217+
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)
218218

219219
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.
220220

221221
### useIssuesForAllMergeRequests
222222

223-
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
223+
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
224224
used to sidestep the problem where pull requests are rejected by GitHub if the feature branch no longer exists or has been merged.
225225

226226
### filterByLabel
@@ -242,7 +242,7 @@ Suggested values:
242242

243243
### mergeRequests
244244

245-
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.
245+
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.
246246

247247
### usermap
248248

0 commit comments

Comments
 (0)