fix(releases): add to readme and sample settings, fix whitespace

Author: gaurav5430

README.md

@@ -104,6 +104,12 @@ If this is set to true (default) then the migration process will transfer issues
 
 If this is set to true (default) then the migration process will transfer merge requests.
 
+#### transfer.releases
+
+If this is set to true (default) then the migration process will transfer releases.
+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
 
 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

@@ -33,6 +33,7 @@ export default {
     labels: true,
     issues: true,
     mergeRequests: true,
+    releases: true,
   },
   debug: false,
   usePlaceholderIssuesForMissingIssues: true,

src/index.ts

@@ -156,8 +156,6 @@ async function migrate() {
         await transferMergeRequests();
       }
     }
-
-
   } catch (err) {
     console.error('Error during transfer:');
     console.error(err);
@@ -484,8 +482,8 @@ async function transferMergeRequests() {
 
   // if a GitLab release does not exist in GitHub repo, create it
   for (let release of releases) {
-    // Try to find a GitHub pull request that already exists for this GitLab
-    // merge request
+    // Try to find an existing github release that already exists for this GitLab
+    // release
     let githubRelease = await githubHelper.getReleaseByTag(release.tag_name);
 
     if (!githubRelease) {
@@ -503,12 +501,10 @@ async function transferMergeRequests() {
         console.error(err);
       }
     } else {
-      if (githubRelease) {
         console.log(
           'Gitlab release already exists (as github release): ' +
           githubRelease.data.name + ' - ' + githubRelease.data.tag_name
         );
-      }
     }
   }
 }