Automatically adjust GitHub PR message if it exceeds a size limit of 60k characters by omitting some of the changelog information (#157)

* fix: body max length

* docs: improve logs

* docs: changeset

* refactor: changeset message to omit some info if message exceeds size limit

* refactor: minor adjustments based on feedback

* Apply nits from code review

* Fixed tests

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>

src/run.test.ts

@@ -57,9 +57,9 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
-    mockedGithubMethods.pulls.create.mockImplementationOnce(
-      () => ({ data: { number: 123 } })
-    );
+    mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
+      data: { number: 123 },
+    }));
 
     await writeChangesets(
       [
@@ -96,9 +96,9 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
-    mockedGithubMethods.pulls.create.mockImplementationOnce(
-      () => ({ data: { number: 123 } })
-    );
+    mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
+      data: { number: 123 },
+    }));
 
     await writeChangesets(
       [
@@ -131,9 +131,9 @@ describe("version", () => {
       () => ({ data: { items: [] } })
     );
 
-    mockedGithubMethods.pulls.create.mockImplementationOnce(
-      () => ({ data: { number: 123 } })
-    );
+    mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
+      data: { number: 123 },
+    }));
 
     await writeChangesets(
       [
@@ -157,4 +157,122 @@ describe("version", () => {
 
     expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
   });
+
+  it("does not include changelog entries if full message exceeds size limit", async () => {
+    let cwd = f.copy("simple-project");
+    linkNodeModules(cwd);
+
+    mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
+      () => ({ data: { items: [] } })
+    );
+
+    mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
+      data: { number: 123 },
+    }));
+
+    await writeChangesets(
+      [
+        {
+          releases: [
+            {
+              name: "simple-project-pkg-a",
+              type: "minor",
+            },
+          ],
+          summary: `# Non manus superum
+
+## Nec cornibus aequa numinis multo onerosior adde
+
+Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
+limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
+locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
+viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
+dictis, qua, in.
+
+In modo. Nomen illa membra.
+
+> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
+> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
+> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
+> dividite proculcat facit, visa.
+
+Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
+decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
+fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
+`,
+        },
+      ],
+      cwd
+    );
+
+    await runVersion({
+      githubToken: "@@GITHUB_TOKEN",
+      cwd,
+      prBodyMaxCharacters: 1000,
+    });
+
+    expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
+    expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
+      /The changelog information of each package has been omitted from this message/
+    );
+  });
+
+  it("does not include any release information if a message with simplified release info exceeds size limit", async () => {
+    let cwd = f.copy("simple-project");
+    linkNodeModules(cwd);
+
+    mockedGithubMethods.search.issuesAndPullRequests.mockImplementationOnce(
+      () => ({ data: { items: [] } })
+    );
+
+    mockedGithubMethods.pulls.create.mockImplementationOnce(() => ({
+      data: { number: 123 },
+    }));
+
+    await writeChangesets(
+      [
+        {
+          releases: [
+            {
+              name: "simple-project-pkg-a",
+              type: "minor",
+            },
+          ],
+          summary: `# Non manus superum
+
+## Nec cornibus aequa numinis multo onerosior adde
+
+Lorem markdownum undas consumpserat malas, nec est lupus; memorant gentisque ab
+limine auctore. Eatque et promptu deficit, quam videtur aequa est **faciat**,
+locus. Potentia deus habebat pia quam qui coniuge frater, tibi habent fertque
+viribus. E et cognoscere arcus, lacus aut sic pro crimina fuit tum **auxilium**
+dictis, qua, in.
+
+In modo. Nomen illa membra.
+
+> Corpora gratissima parens montibus tum coeperat qua remulus caelum Helenamque?
+> Non poenae modulatur Amathunta in concita superi, procerum pariter rapto cornu
+> munera. Perrhaebum parvo manus contingere, morari, spes per totiens ut
+> dividite proculcat facit, visa.
+
+Adspicit sequitur diffamatamque superi Phoebo qua quin lammina utque: per? Exit
+decus aut hac inpia, seducta mirantia extremo. Vidi pedes vetus. Saturnius
+fluminis divesque vulnere aquis parce lapsis rabie si visa fulmineis.
+`,
+        },
+      ],
+      cwd
+    );
+
+    await runVersion({
+      githubToken: "@@GITHUB_TOKEN",
+      cwd,
+      prBodyMaxCharacters: 500,
+    });
+
+    expect(mockedGithubMethods.pulls.create.mock.calls[0]).toMatchSnapshot();
+    expect(mockedGithubMethods.pulls.create.mock.calls[0][0].body).toMatch(
+      /All release information have been omitted from this message, as the content exceeds the size limit/
+    );
+  });
 });