feat: improve CI status messages

Author: jamacku

dist/index.js

@@ -2,6 +2,7 @@ import { debug } from '@actions/core';
 import { z } from 'zod';
 
 import { CustomOctokit } from './octokit';
+import { makeList } from './util';
 
 import {
   CheckRuns,
@@ -76,8 +77,8 @@ export class PullRequest {
     } else {
       checkRunsSuccess = false;
       const failedChecks = this.isFailedOrPending(checkRuns);
-      message += `Failed or pending checks - ${failedChecks.failed.concat(
-        failedChecks.pending
+      message += `Failed or pending checks - ${makeList(
+        failedChecks.failed.concat(failedChecks.pending)
       )}`;
     }
 
@@ -92,9 +93,11 @@ export class PullRequest {
       statusSuccess = false;
       const failedStatuses = this.isFailedOrPendingStatuses(status.statuses);
       message.length > 0 && (message += '\t');
-      message += `Failed or pending statuses - ${failedStatuses.error.concat(
-        failedStatuses.failed,
-        failedStatuses.pending
+      message += `Failed or pending statuses - ${makeList(
+        failedStatuses.error.concat(
+          failedStatuses.failed,
+          failedStatuses.pending
+        )
       )}`;
     }
 

dist/index.js.map

@@ -95,3 +95,9 @@ export async function removeLabel(
 export function raise(error: string): never {
   throw new ValidationError(error);
 }
+
+export function makeList(items: string[]): string {
+  if (items.length === 0) return '';
+
+  return items.map(item => `* ${item}`).join('\n');
+}

dist/pull-request.js

@@ -1,6 +1,11 @@
 import { describe, expect, test } from 'vitest';
 
-import { getFailedMessage, getSuccessMessage, raise } from '../../src/util';
+import {
+  getFailedMessage,
+  getSuccessMessage,
+  makeList,
+  raise,
+} from '../../src/util';
 
 describe('Test Util functions', () => {
   test('getFailedMessage()', () => {
@@ -27,4 +32,16 @@ describe('Test Util functions', () => {
 
   test('raise()', () =>
     expect(() => raise('test error')).toThrowError('test error'));
+
+  test('makeList()', () => {
+    let list = ['item1', 'item2', 'item3'];
+    expect(makeList(list)).toMatchInlineSnapshot(`
+      "* item1
+      * item2
+      * item3"
+    `);
+
+    list = [];
+    expect(makeList(list)).toBe('');
+  });
 });