Transfer repository description by default

Reads GitHub project description, removes newlines and tabs, and updates the
GitHub repository description. This can be disabled by setting
the `transfer.description` setting to `false`.

Author: akaihola

sample_settings.ts

@@ -29,6 +29,7 @@ export default {
     useLowerCaseLabels: true,
   },
   transfer: {
+    description: true,
     milestones: true,
     labels: true,
     issues: true,

src/githubHelper.ts

@@ -205,6 +205,20 @@ export default class GithubHelper {
    ******************************************************************************
    */
 
+  /**
+   * Update the description of the repository on GitHub.
+   * Replaces newlines and tabs with spaces. No attempt is made to remove e.g. Markdown
+   * links or other special formatting.
+   */
+  async updateRepositoryDescription(description) {
+    let props : RestEndpointMethodTypes["repos"]["update"]["parameters"] = {
+      owner: this.githubOwner,
+      repo: this.githubRepo,
+      description: description.replace(/\s+/g, " ")
+    }
+    return this.githubApi.repos.update(props);
+  }
+
   /**
    * TODO description
    */

src/index.ts

@@ -127,6 +127,11 @@ async function migrate() {
 
     await githubHelper.registerRepoId();
 
+    // transfer GitLab description to GitHub
+    if (settings.transfer.description) {
+      await transferDescription();
+    }
+
     // transfer GitLab milestones to GitHub
     if (settings.transfer.milestones) {
       await transferMilestones();
@@ -159,6 +164,22 @@ async function migrate() {
 
 // ----------------------------------------------------------------------------
 
+/**
+ * Transfer the description of the repository.
+ */
+async function transferDescription() {
+  inform('Transferring Description');
+
+  // Get the description of this project
+  let project = await gitlabApi.Projects.show(
+    settings.gitlab.projectId
+  ) as any;
+
+  await githubHelper.updateRepositoryDescription(project.description);
+}
+
+// ----------------------------------------------------------------------------
+
 /**
  * Transfer any milestones that exist in GitLab that do not exist in GitHub.
  */

src/settings.ts

@@ -12,6 +12,7 @@ export default interface Settings {
     useLowerCaseLabels: boolean;
   };
   transfer: {
+    description: boolean;
     milestones: boolean;
     labels: boolean;
     issues: boolean;