feat: friendly error messages, add review comment output

README.md

@@ -89,3 +89,4 @@ body-check | Result of match for PR Body against configured regex.
 branch-check | Result of check to ensure PR head is not protected branch.
 title-check | Result of check to ensure PR title is formatted per [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
 watch-files-check | Result of check for watched files having been modified. True if no modifications found to watched files.
+review-comment | The pull request review comment that the action will attempt to create/update.

action.yml

@@ -141,6 +141,8 @@ outputs:
     description: 'Result of check to ensure PR title is formatted per [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)'
   watch-files-check:
     description: 'Result of check for watched files having been modified. True if no modifications found to watched files.'
+  review-comment:
+    description: 'Pull request review comment that the action will attempt to create/update.'
 runs:
   using: 'node16'
   main: 'dist/index.js'

src/main.ts

@@ -16,6 +16,18 @@ type PullRequestReview = {
   state: string
 }
 
+const errors = {
+  findExistingReview:
+    'An error was encountered when searching for a pull request review comment previously left by this action.',
+  checkingTeamMember:
+    'An error was encountered when checking whether the PR author is a team member.',
+  updatingReview:
+    'An error was encountered when updating a pull request review comment previously left by this action.',
+  creatingReview:
+    'An error was encountered when creating a pull request review comment.',
+  closingPullRequest: 'An error was encountered when closing the pull request.'
+}
+
 const repoToken = core.getInput('repo-token')
 const ignoreAuthors = core.getMultilineInput('ignore-authors')
 const ignoreTeamMembers = core.getBooleanInput('ignore-team-members')
@@ -168,13 +180,15 @@ async function run(): Promise<void> {
       let reviewBody = ''
       if (commentsToLeave.length > 0)
         reviewBody = [baseComment, ...commentsToLeave].join('\n\n')
+      core.setOutput('review-comment', reviewBody)
       await updateReview(
         {owner: pr.owner, repo: pr.repo, pull_number: pr.number},
         reviewBody
       )
       // Finally close PR if warranted
       if (shouldClosePr) await closePullRequest(pr.number)
     } else {
+      core.setOutput('review-comment', '')
       await updateReview(
         {owner: pr.owner, repo: pr.repo, pull_number: pr.number},
         ''
@@ -185,11 +199,15 @@ async function run(): Promise<void> {
   }
 }
 async function closePullRequest(number: number) {
-  await client.rest.pulls.update({
-    ...context.repo,
-    pull_number: number,
-    state: 'closed'
-  })
+  try {
+    await client.rest.pulls.update({
+      ...context.repo,
+      pull_number: number,
+      state: 'closed'
+    })
+  } catch (error) {
+    if (error instanceof Error) throw new Error(errors.closingPullRequest)
+  }
 }
 function escapeChecks(checkResult: boolean, message: string) {
   core.info(message)
@@ -198,27 +216,38 @@ function escapeChecks(checkResult: boolean, message: string) {
   core.setOutput('issue-label-check', checkResult)
   core.setOutput('title-check', checkResult)
   core.setOutput('watched-files-check', checkResult)
+  core.setOutput('review-comment', '')
 }
 async function listFiles(pullRequest: {
   owner: string
   repo: string
   pull_number: number
 }) {
-  const {data: files} = await client.rest.pulls.listFiles(pullRequest)
-  return files
+  try {
+    const {data: files} = await client.rest.pulls.listFiles(pullRequest)
+    return files
+  } catch (error) {
+    if (error instanceof Error) throw new Error(errors.findExistingReview)
+    return []
+  }
 }
 async function findExistingReview(pullRequest: {
   owner: string
   repo: string
   pull_number: number
 }): Promise<PullRequestReview | null> {
-  let review
-  const {data: reviews} = await client.rest.pulls.listReviews(pullRequest)
-  review = reviews.find(innerReview => {
-    return (innerReview?.user?.login ?? '') === 'github-actions[bot]'
-  })
-  if (review === undefined) review = null
-  return review
+  try {
+    let review
+    const {data: reviews} = await client.rest.pulls.listReviews(pullRequest)
+    review = reviews.find(innerReview => {
+      return (innerReview?.user?.login ?? '') === 'github-actions[bot]'
+    })
+    if (review === undefined) review = null
+    return review
+  } catch (error) {
+    if (error instanceof Error) throw new Error(errors.findExistingReview)
+    return null
+  }
 }
 async function updateReview(
   pullRequest: {owner: string; repo: string; pull_number: number},
@@ -231,39 +260,59 @@ async function updateReview(
   if (body === review?.body) return
   // if no existing review, body non blank, create a review
   if (review === null && body !== '') {
-    await client.rest.pulls.createReview({
-      ...pullRequest,
-      body,
-      event: 'COMMENT'
-    })
-    return
+    try {
+      await client.rest.pulls.createReview({
+        ...pullRequest,
+        body,
+        event: 'COMMENT'
+      })
+    } catch (error) {
+      if (error instanceof Error) throw new Error(errors.creatingReview)
+      return
+    }
   }
   // if body blank and review exists, update it to show passed
   if (review !== null && body === '') {
-    await client.rest.pulls.updateReview({
-      ...pullRequest,
-      review_id: review.id,
-      body: 'PR Compliance Checks Passed!'
-    })
-    return
+    try {
+      await client.rest.pulls.updateReview({
+        ...pullRequest,
+        review_id: review.id,
+        body: 'PR Compliance Checks Passed!'
+      })
+    } catch (error) {
+      if (error instanceof Error) throw new Error(errors.updatingReview)
+      return
+    }
   }
   // if body non-blank and review exists, update it
   if (review !== null && body !== review?.body) {
-    await client.rest.pulls.updateReview({
-      ...pullRequest,
-      review_id: review.id,
-      body
-    })
-    return
+    try {
+      await client.rest.pulls.updateReview({
+        ...pullRequest,
+        review_id: review.id,
+        body
+      })
+    } catch (error) {
+      if (error instanceof Error) throw new Error(errors.updatingReview)
+      return
+    }
   }
 }
-async function userIsTeamMember(login: string, owner: string) {
+async function userIsTeamMember(
+  login: string,
+  owner: string
+): Promise<boolean> {
   if (login === owner) return true
-  const {data: userOrgs} = await client.request('GET /users/{user}/orgs', {
-    user: login
-  })
-  return userOrgs.some((userOrg: {login: string}) => {
-    return userOrg.login === owner
-  })
+  try {
+    const {data: userOrgs} = await client.request('GET /users/{user}/orgs', {
+      user: login
+    })
+    return userOrgs.some((userOrg: {login: string}) => {
+      return userOrg.login === owner
+    })
+  } catch (error) {
+    if (error instanceof Error) throw new Error(errors.checkingTeamMember)
+    return false
+  }
 }
 run()