Function commentOnPR

packages/ci/src/lib/comment.ts:5–40

(
  mdPath: string,
  api: ProviderAPIClient,
  settings: Pick<Settings, 'jobId'>,
)

import type { ProviderAPIClient, Settings } from './models.js';

export async function commentOnPR(
  mdPath: string,
  api: ProviderAPIClient,
  settings: Pick<Settings, 'jobId'>,
): Promise<number> {
  const markdown = await readFile(mdPath, 'utf8');
  const identifier = settings.jobId
    ? `<!-- generated by @code-pushup/ci [jobId=${settings.jobId}] -->`
    : '<!-- generated by @code-pushup/ci -->';
  const body = truncateBody(
    `${markdown}\n\n${identifier}\n`,
    api.maxCommentChars,
  );

  const comments = await api.listComments();
  logDebug(`Fetched ${comments.length} comments for pull request`);

  const prevComment = comments.find(comment =>
    comment.body.includes(identifier),
  );
  logDebug(
    prevComment
      ? `Found previous comment ${prevComment.id} from Code PushUp`
      : 'Previous Code PushUp comment not found',
  );

  if (prevComment) {
    const updatedComment = await api.updateComment(prevComment.id, body);
    logInfo(`Updated body of comment ${updatedComment.url}`);
    return updatedComment.id;
  }

  const createdComment = await api.createComment(body);
  logInfo(`Created new comment ${createdComment.url}`);
  return createdComment.id;
}

function truncateBody(body: string, max: number): string {
  const truncateWarning = '...*[Comment body truncated]*';