Merge pull request #94 from gaurav5430/master

feat(releases): migrate releases from gitlab to github

Author: spruce

README.md

@@ -128,6 +128,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

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

src/githubHelper.ts

@@ -186,6 +186,62 @@ export 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

@@ -161,6 +161,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();
@@ -477,6 +484,61 @@ 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 an existing github release that already exists for this GitLab
+    // release
+    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 {
+        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;
   };
   useIssueImportAPI: boolean;
   usePlaceholderIssuesForMissingIssues: boolean;