feat(releases): migrate releases from gitlab to github

Author: gaurav5430

src/githubHelper.ts

@@ -160,6 +160,62 @@ export default class GithubHelper {
 
   // ----------------------------------------------------------------------------
 
+  
+  /**
+   * Gets a release by tag name
+   * @param tag {string} - the tag name to search a release for
+   * @returns 
+   */
+   async getReleaseByTag(tag) {
+    try {
+      await utils.sleep(this.delayInMs);
+      // get an existing release by tag name in github
+      let result = await this.githubApi.repos.getReleaseByTag({
+        owner: this.githubOwner,
+        repo: this.githubRepo,
+        tag: tag
+      });
+
+      return result;
+    } catch (err) {
+      console.error('No existing release for this tag on github');
+      return null;
+    }
+  }
+
+  // ----------------------------------------------------------------------------
+
+  /**
+   * Creates a new release on github
+   * @param tag_name {string} - the tag name
+   * @param name {string} - title of the release
+   * @param body {string} - description for the release
+   */
+   async createRelease(
+    tag_name: string, 
+    name: string,
+    body: string) {
+    try {
+      await utils.sleep(this.delayInMs);
+      // get an array of GitHub labels for the new repo
+      let result = await this.githubApi.repos.createRelease({
+        owner: this.githubOwner,
+        repo: this.githubRepo,
+        tag_name,
+        name,
+        body,
+      });
+
+      return result;
+    } catch (err) {
+      console.error('Could not create release on github');
+      console.error(err);
+      return null;
+    }
+  }
+
+  // ----------------------------------------------------------------------------
+
   /**
    * Get a list of all the current GitHub pull requests.
    * This uses a while loop to make sure that each page of issues is received.

src/index.ts

@@ -137,6 +137,13 @@ async function migrate() {
       await transferLabels(true, settings.conversion.useLowerCaseLabels);
     }
 
+
+    // transfer GitLab releases to GitHub
+    if (settings.transfer.releases) {
+      await transferReleases();
+    }
+
+
     // Transfer issues with their comments; do this before transferring the merge requests
     if (settings.transfer.issues) {
       await transferIssues();
@@ -149,6 +156,8 @@ async function migrate() {
         await transferMergeRequests();
       }
     }
+
+
   } catch (err) {
     console.error('Error during transfer:');
     console.error(err);
@@ -447,6 +456,63 @@ async function transferMergeRequests() {
   }
 }
 
+/**
+ * Transfer any releases that exist in GitLab that do not exist in GitHub
+ * Please note that due to github api restrictions, this only transfers the 
+ * name, description and tag name of the release. It sorts the releases chronologically
+ * and creates them on github one by one
+ * @returns {Promise<void>}
+ */
+ async function transferReleases() {
+  inform('Transferring Releases');
+
+  // Get a list of all releases associated with this project
+  let releases = await gitlabApi.Releases.all(settings.gitlab.projectId) as any;
+
+  // Sort releases in ascending order of their release date
+  releases = releases.sort((a, b) => {
+    return (new Date(a.released_at) as any) - (new Date(b.released_at) as any);
+  });
+
+  console.log(
+    'Transferring ' + releases.length.toString() + ' releases'
+  );
+
+  //
+  // Create GitHub release for each GitLab release
+  //
+
+  // 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
+    let githubRelease = await githubHelper.getReleaseByTag(release.tag_name);
+    
+    if (!githubRelease) {
+      console.log(
+        'Creating release: !' + release.name + ' - ' + release.tag_name
+      );
+      try {
+        // process asynchronous code in sequence
+        await githubHelper.createRelease(release.tag_name, release.name, release.description);
+      } catch (err) {
+        console.error(
+          'Could not create release: !' +
+          release.name + ' - ' + release.tag_name
+        );
+        console.error(err);
+      }
+    } else {
+      if (githubRelease) {
+        console.log(
+          'Gitlab release already exists (as github release): ' +
+          githubRelease.data.name + ' - ' + githubRelease.data.tag_name
+        );
+      }
+    }
+  }
+}
+
 //-----------------------------------------------------------------------------
 
 /**

src/settings.ts

@@ -16,6 +16,7 @@ export default interface Settings {
     labels: boolean;
     issues: boolean;
     mergeRequests: boolean;
+    releases: boolean;
   };
   usePlaceholderIssuesForMissingIssues: boolean;
   useReplacementIssuesForCreationFails: boolean;