chore(ci): display skipped commits in release issue (#434)

Author: eunjae-lee

scripts/release/__tests__/create-release-issue.test.ts

@@ -1,6 +1,7 @@
 import {
   parseCommit,
   getVersionChangesText,
+  getSkippedCommitsText,
   decideReleaseStrategy,
   readVersions,
 } from '../create-release-issue';
@@ -247,4 +248,33 @@ describe('create release issue', () => {
     expect(versions.java.skipRelease).toBeUndefined();
     expect(versions.php.skipRelease).toBeUndefined();
   });
+
+  it('generates text for skipped commits', () => {
+    expect(
+      getSkippedCommitsText({
+        commitsWithoutLanguageScope: [],
+        commitsWithUnknownLanguageScope: [],
+      })
+    ).toMatchInlineSnapshot(`"_(None)_"`);
+
+    expect(
+      getSkippedCommitsText({
+        commitsWithoutLanguageScope: ['abcdefg fix: something'],
+        commitsWithUnknownLanguageScope: ['abcdef2 fix(pascal): what'],
+      })
+    ).toMatchInlineSnapshot(`
+      "<p></p>
+        <p>It doesn't mean these commits are being excluded from the release. It means they're not taken into account when the release process figured out the next version number, and updated the changelog.</p>
+
+        <p>Commits without language scope:</p>
+        <ul>
+          <li>abcdefg fix: something</li>
+        </ul>
+
+        <p>Commits with unknown language scope:</p>
+        <ul>
+          <li>abcdef2 fix(pascal): what</li>
+        </ul>"
+    `);
+  });
 });

scripts/release/create-release-issue.ts

@@ -59,6 +59,34 @@ export function getVersionChangesText(versions: Versions): string {
   }).join('\n');
 }
 
+export function getSkippedCommitsText({
+  commitsWithoutLanguageScope,
+  commitsWithUnknownLanguageScope,
+}: {
+  commitsWithoutLanguageScope: string[];
+  commitsWithUnknownLanguageScope: string[];
+}): string {
+  if (
+    commitsWithoutLanguageScope.length === 0 &&
+    commitsWithUnknownLanguageScope.length === 0
+  ) {
+    return '_(None)_';
+  }
+
+  return `<p></p>
+  <p>${TEXT.skippedCommitsDesc}</p>
+
+  <p>Commits without language scope:</p>
+  <ul>
+    ${commitsWithoutLanguageScope.map((commit) => `<li>${commit}</li>`)}
+  </ul>
+
+  <p>Commits with unknown language scope:</p>
+  <ul>
+    ${commitsWithUnknownLanguageScope.map((commit) => `<li>${commit}</li>`)}
+  </ul>`;
+}
+
 export function parseCommit(commit: string): Commit {
   const LENGTH_SHA1 = 8;
   const hash = commit.slice(0, LENGTH_SHA1);
@@ -217,24 +245,18 @@ async function createReleaseIssue(): Promise<void> {
     })
     .filter(Boolean) as PassedCommit[];
 
-  console.log('[INFO] Skipping these commits due to lack of language scope:');
-  console.log(
-    commitsWithoutLanguageScope.map((commit) => `  ${commit}`).join('\n')
-  );
-
-  console.log('');
-  console.log('[INFO] Skipping these commits due to unknown language scope:');
-  console.log(
-    commitsWithUnknownLanguageScope.map((commit) => `  ${commit}`).join('\n')
-  );
-
   const versions = decideReleaseStrategy({
     versions: readVersions(),
     commits: latestCommits,
   });
 
   const versionChanges = getVersionChangesText(versions);
 
+  const skippedCommits = getSkippedCommitsText({
+    commitsWithoutLanguageScope,
+    commitsWithUnknownLanguageScope,
+  });
+
   const changelogs = LANGUAGES.filter(
     (lang) => !versions[lang].noCommit && versions[lang].current
   )
@@ -256,6 +278,8 @@ async function createReleaseIssue(): Promise<void> {
     TEXT.header,
     TEXT.versionChangeHeader,
     versionChanges,
+    TEXT.skippedCommitsHeader,
+    skippedCommits,
     TEXT.descriptionVersionChanges,
     TEXT.indenpendentVersioning,
     TEXT.changelogHeader,

scripts/release/text.ts

@@ -2,6 +2,8 @@ export default {
   header: `## Summary`,
 
   versionChangeHeader: `## Version Changes`,
+  skippedCommitsHeader: `### Skipped Commits`,
+  skippedCommitsDesc: `It doesn't mean these commits are being excluded from the release. It means they're not taken into account when the release process figured out the next version number, and updated the changelog.`,
   noCommit: `no commit`,
   currentVersionNotFound: `current version not found`,
   descriptionVersionChanges: [