fix: correct data shape for octokit.checks.update call (#143)

electron · Aug 9, 2023 · 2fbfbf7 · 2fbfbf7
1 parent be709b4
commit 2fbfbf7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 10 deletions.
diff --git a/spec/api-review-state.spec.ts b/spec/api-review-state.spec.ts
@@ -383,7 +383,10 @@ describe('api review', () => {
     const expected = {
       name: API_REVIEW_CHECK_NAME,
       status: 'completed',
-      title: 'PR no longer requires API Review',
+      output: {
+        title: 'Outdated',
+        summary: 'PR no longer requires API Review',
+      },
       conclusion: CheckRunStatus.NEUTRAL,
     };
 

diff --git a/src/api-review-state.ts b/src/api-review-state.ts
@@ -88,15 +88,20 @@ export async function addOrUpdateAPIReviewCheck(octokit: Context['octokit'], pr:
 
   const resetToNeutral = async () => {
     if (!checkRun) return;
-    return await octokit.checks.update({
-      owner,
-      repo,
-      name: API_REVIEW_CHECK_NAME,
-      status: 'completed',
-      title: 'PR no longer requires API Review',
-      check_run_id: checkRun.id,
-      conclusion: CheckRunStatus.NEUTRAL,
-    });
+    const params: Endpoints['PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}']['parameters'] =
+      {
+        owner,
+        repo,
+        name: API_REVIEW_CHECK_NAME,
+        status: 'completed',
+        output: {
+          title: 'Outdated',
+          summary: 'PR no longer requires API Review',
+        },
+        check_run_id: checkRun.id,
+        conclusion: CheckRunStatus.NEUTRAL,
+      };
+    return await octokit.checks.update(params);
   };
 
   // We do not care about PRs without an API review label of any kind.