adding comment when check fails (#53)

Author: karpikpl

__tests__/main.test.js

@@ -55,13 +55,22 @@ const createChecksMock = jest.fn().mockResolvedValue({
   data: {}
 })
 
+const createCommentMock = jest.fn().mockResolvedValue({
+  status: 200,
+  headers: {},
+  data: {}
+})
+
 const getOctokitMock = jest
   .spyOn(github, 'getOctokit')
   .mockImplementation(() => {
     return {
       rest: {
         checks: {
           create: createChecksMock
+        },
+        issues: {
+          createComment: createCommentMock
         }
       }
     }
@@ -176,16 +185,33 @@ describe('action', () => {
     expect(setOutputMock).toHaveBeenNthCalledWith(1, 'result', 'Success')
   })
 
+  it('creates a comment when github checks API fails', async () => {
+    // Set the action's inputs as return values from core.getInput()
+    mockInput()
+    github.context = {
+      payload: { pull_request: { number: 123 } },
+      issue: { number: 123 }
+    }
+    createChecksMock.mockRejectedValue(new Error('Failed to create check'))
+
+    await main.run()
+    expect(runMock).toHaveReturned()
+
+    // Verify that comment was created
+    expect(createCommentMock).toHaveBeenCalled()
+  })
+
   it('sets a failed status when github fails', async () => {
     // Set the action's inputs as return values from core.getInput()
     mockInput()
     createChecksMock.mockRejectedValue(new Error('Failed to create check'))
+    createCommentMock.mockRejectedValue(new Error('Failed to create comment'))
 
     await main.run()
     expect(runMock).toHaveReturned()
 
     // Verify that all of the core library functions were called correctly
-    expect(setFailedMock).toHaveBeenNthCalledWith(1, 'Failed to create check')
+    expect(setFailedMock).toHaveBeenNthCalledWith(1, 'Failed to create comment')
   })
 
   it('fails if no pylint file provided', async () => {

badges/coverage.svg

@@ -58,27 +58,53 @@ async function run() {
 
     const octokit = github.getOctokit(token)
 
-    const resp = await octokit.rest.checks.create({
-      owner: repo_owner,
-      repo: repo_name,
-      name: 'pylint',
-      head_sha: headSha,
-      completed_at: new Date().toISOString(),
-      conclusion,
-      status: 'completed',
-      output: {
-        title:
-          conclusion === 'success'
-            ? 'No issues have been found!'
-            : 'Pylint has some suggestions!',
-        summary:
-          conclusion === 'success'
-            ? 'No issues have been found!'
-            : `Pylint has some suggestions!'${trimmedWarning}'`,
-        annotations
+    try {
+      const resp = await octokit.rest.checks.create({
+        owner: repo_owner,
+        repo: repo_name,
+        name: 'pylint',
+        head_sha: headSha,
+        completed_at: new Date().toISOString(),
+        conclusion,
+        status: 'completed',
+        output: {
+          title:
+            conclusion === 'success'
+              ? 'No issues have been found!'
+              : 'Pylint has some suggestions!',
+          summary:
+            conclusion === 'success'
+              ? 'No issues have been found!'
+              : `Pylint has some suggestions!'${trimmedWarning}'`,
+          annotations
+        }
+      })
+      core.debug(`response from checks create: ${resp.status}`)
+    } catch (checkError) {
+      core.error(`Error creating checks: ${checkError}`)
+      core.debug('Trying to add a comment instead')
+
+      const comment = annotations
+        .map(
+          annotation =>
+            `::${annotation.annotation_level} file=${annotation.path},line=${annotation.start_line},col=${annotation.start_column}::${annotation.message}`
+        )
+        .join('\n')
+
+      const issueNumber =
+        github.context?.payload?.pull_request?.number ||
+        github.context?.issue?.number
+      if (issueNumber) {
+        const commentResp = await octokit.rest.issues.createComment({
+          owner: repo_owner,
+          repo: repo_name,
+          issue_number: issueNumber,
+          body: comment
+        })
+        core.debug(`response from comment create: ${commentResp.status}`)
       }
-    })
-    core.debug(`response from checks create: ${resp.status}`)
+    }
+
     core.setOutput('result', 'Success')
   } catch (error) {
     // Fail the workflow run if an error occurs