Rename debug to dryRun

fixes piceaTech#136

Author: spruce

README.md

@@ -182,7 +182,7 @@ If this is set to true (default) then the migration process will transfer releas
 Note that github api for releases is limited and hence this will only transfer the title and description of the releases
 and add them to github in chronological order, but it would not preserve the original release dates, nor transfer artefacts or assets.
 
-### debug
+### dryRun
 
 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
 

sample_settings.ts

@@ -4,9 +4,9 @@ export default {
   gitlab: {
     // url: 'https://gitlab.mycompany.com',
     token: '{{gitlab private token}}',
-    projectId: null,
+    projectId: 0,
     listArchivedProjects: true,
-    sessionCookie: null,
+    sessionCookie: "",
   },
   github: {
     // baseUrl: 'https://github.mycompany.com:123/etc',
@@ -42,13 +42,13 @@ export default {
     mergeRequests: true,
     releases: true,
   },
-  debug: false,
+  dryRun: false,
   useIssueImportAPI: true,
   usePlaceholderMilestonesForMissingMilestones: true,
   usePlaceholderIssuesForMissingIssues: true,
   useReplacementIssuesForCreationFails: true,
   useIssuesForAllMergeRequests: false,
-  filterByLabel: null,
+  filterByLabel: undefined,
   trimOversizedLabelDescriptions: false,
   skipMergeRequestStates: [],
   skipMatchingComments: [],

src/githubHelper.ts

@@ -353,7 +353,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return Promise.resolve({ data: issue });
+    if (settings.dryRun) return Promise.resolve({ data: issue });
 
     return this.githubApi.issues.create(props);
   }
@@ -454,7 +454,7 @@ export class GithubHelper {
     props.milestone = this.convertMilestone(issue);
     props.labels = this.convertLabels(issue);
 
-    if (settings.debug) return Promise.resolve({ data: issue });
+    if (settings.dryRun) return Promise.resolve({ data: issue });
 
     //
     // Issue comments
@@ -676,7 +676,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return true;
+    if (settings.dryRun) return true;
 
     await this.githubApi.issues
       .createComment({
@@ -711,7 +711,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return Promise.resolve();
+    if (settings.dryRun) return Promise.resolve();
 
     return await this.githubApi.issues.update(props);
   }
@@ -746,7 +746,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return Promise.resolve({ number: -1, title: 'DEBUG' });
+    if (settings.dryRun) return Promise.resolve({ number: -1, title: 'DEBUG' });
 
     const created = await this.githubApi.issues.createMilestone(
       githubMilestone
@@ -772,7 +772,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return Promise.resolve();
+    if (settings.dryRun) return Promise.resolve();
     // create the GitHub label
     return await this.githubApi.issues.createLabel(githubLabel);
   }
@@ -870,7 +870,7 @@ export class GithubHelper {
       }
     }
 
-    if (settings.debug) return Promise.resolve({ data: mergeRequest });
+    if (settings.dryRun) return Promise.resolve({ data: mergeRequest });
 
     if (canCreate) {
       let bodyConverted = await this.convertIssuesAndComments(
@@ -1055,7 +1055,7 @@ export class GithubHelper {
     if (
       mergeRequest.state === 'merged' &&
       pullRequest.state !== 'closed' &&
-      !settings.debug
+      !settings.dryRun
     ) {
       // Merging the pull request adds new commits to the tree; to avoid that, just close the merge requests
       mergeRequest.state = 'closed';
@@ -1074,7 +1074,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) {
+    if (settings.dryRun) {
       return Promise.resolve();
     }
 

src/settings.ts

@@ -1,5 +1,5 @@
 export default interface Settings {
-  debug: boolean;
+  dryRun: boolean;
   gitlab: GitlabSettings;
   github: GithubSettings;
   usermap: {