fix(version): truncate release body based on maximum size allowed by VCS client (lerna#4041)

Author: msobiecki

libs/commands/version/src/index.ts

@@ -36,7 +36,7 @@ import pReduce from "p-reduce";
 import pWaterfall from "p-waterfall";
 import path from "path";
 import semver, { ReleaseType } from "semver";
-import { createRelease, createReleaseClient } from "./lib/create-release";
+import { createRelease, createReleaseClient, ReleaseClientType } from "./lib/create-release";
 import { getCurrentBranch } from "./lib/get-current-branch";
 import { gitAdd } from "./lib/git-add";
 import { gitCommit } from "./lib/git-commit";
@@ -76,7 +76,7 @@ interface VersionCommandConfigOptions extends CommandConfigOptions {
   forceGitTag?: boolean;
   tagVersionPrefix?: string;
   tagVersionSeparator?: string;
-  createRelease?: "github" | "gitlab";
+  createRelease?: ReleaseClientType;
   changelog?: boolean;
   exact?: boolean;
   conventionalPrerelease?: string;
@@ -390,6 +390,7 @@ class VersionCommand extends Command {
         createRelease(
           this.releaseClient,
           {
+            type: this.options.createRelease,
             tags: this.tags,
             tagVersionSeparator: this.options.tagVersionSeparator || "@",
             releaseNotes: this.releaseNotes,

libs/commands/version/src/lib/create-release.spec.ts

@@ -0,0 +1,44 @@
+import { truncateReleaseBody } from "./create-release";
+
+describe("truncateReleaseBody", () => {
+  const generateRandomString = (length: number): string => {
+    const letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    let result = "";
+    for (let i = 0; i < length; i++) {
+      result += letters.charAt(Math.floor(Math.random() * letters.length));
+    }
+    return result;
+  };
+
+  it("should not truncate when body length is within limit for GitHub", () => {
+    const body = generateRandomString(124999);
+    const truncatedBody = truncateReleaseBody(body, "github");
+    expect(truncatedBody).toBe(body);
+  });
+
+  it("should not truncate when body length is within limit for GitLab", () => {
+    const body = generateRandomString(999999);
+    const truncatedBody = truncateReleaseBody(body, "gitlab");
+    expect(truncatedBody).toBe(body);
+  });
+
+  it("should truncate when body length exceeds limit for GitHub", () => {
+    const body = generateRandomString(125001);
+    const truncatedBody = truncateReleaseBody(body, "github");
+    expect(truncatedBody.length).toBe(125000);
+    expect(truncatedBody.endsWith("...")).toBe(true);
+  });
+
+  it("should truncate when body length exceeds limit for GitLab", () => {
+    const body = generateRandomString(1000001);
+    const truncatedBody = truncateReleaseBody(body, "gitlab");
+    expect(truncatedBody.length).toBe(1000000);
+    expect(truncatedBody.endsWith("...")).toBe(true);
+  });
+
+  it("should return the body as is when type is undefined", () => {
+    const body = generateRandomString(150000);
+    const truncatedBody = truncateReleaseBody(body);
+    expect(truncatedBody).toBe(body);
+  });
+});

libs/commands/version/src/lib/create-release.ts

@@ -2,7 +2,30 @@ import { createGitHubClient, createGitLabClient, parseGitRepo, ValidationError }
 import { ExecOptions } from "child_process";
 import semver from "semver";
 
-export function createReleaseClient(type: "github" | "gitlab") {
+export type ReleaseClientType = "gitlab" | "github";
+
+export function truncateReleaseBody(body: string, type?: ReleaseClientType) {
+  let maxReleaseBodyLength: number | undefined;
+
+  switch (type) {
+    case "gitlab":
+      maxReleaseBodyLength = 1000000;
+      break;
+    case "github":
+      maxReleaseBodyLength = 125000;
+      break;
+    default:
+      return body;
+  }
+
+  if (body.length > maxReleaseBodyLength) {
+    const ellipsis = "...";
+    return body.slice(0, maxReleaseBodyLength - ellipsis.length) + ellipsis;
+  }
+  return body;
+}
+
+export function createReleaseClient(type?: ReleaseClientType) {
   switch (type) {
     case "gitlab":
       return createGitLabClient();
@@ -17,10 +40,16 @@ export function createReleaseClient(type: "github" | "gitlab") {
 export function createRelease(
   client: ReturnType<typeof createReleaseClient>,
   {
+    type,
     tags,
     releaseNotes,
     tagVersionSeparator,
-  }: { tags: string[]; tagVersionSeparator: string; releaseNotes: { name: string; notes: string }[] },
+  }: {
+    type?: ReleaseClientType;
+    tags: string[];
+    tagVersionSeparator: string;
+    releaseNotes: { name: string; notes: string }[];
+  },
   { gitRemote, execOpts }: { gitRemote: string; execOpts: ExecOptions }
 ) {
   const repo = parseGitRepo(gitRemote, execOpts);
@@ -37,12 +66,14 @@ export function createRelease(
 
       const prereleaseParts = semver.prerelease(tag.replace(`${name}${tagVersionSeparator}`, "")) || [];
 
+      const body = truncateReleaseBody(notes, type);
+
       return client.repos.createRelease({
         owner: repo.owner,
         repo: repo.name,
         tag_name: tag,
         name: tag,
-        body: notes,
+        body,
         draft: false,
         prerelease: prereleaseParts.length > 0,
       });