Use checks field to check required status checks.

reitermarkus · Feb 19, 2024 · 80a3028 · 80a3028
1 parent a77423e
commit 80a3028
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -1,7 +1,7 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 
-import { ReviewAuthorAssociation, Octokit, PullRequest, Review } from './types'
+import { ReviewAuthorAssociation, Octokit, PullRequest, Review, RequiredStatusCheck } from './types'
 
 export const UNMERGEABLE_STATES = ['blocked']
 
@@ -57,7 +57,10 @@ export function isApprovedByAllowedAuthor(
   return isReviewAuthorAllowed(review, authorAssociations)
 }
 
-export async function requiredStatusChecksForBranch(octokit: Octokit, branchName: string): Promise<string[]> {
+export async function requiredStatusChecksForBranch(
+  octokit: Octokit,
+  branchName: string
+): Promise<RequiredStatusCheck[]> {
   const branch = (
     await octokit.rest.repos.getBranch({
       ...github.context.repo,
@@ -66,7 +69,7 @@ export async function requiredStatusChecksForBranch(octokit: Octokit, branchName
   ).data
 
   if (branch.protected === true && branch.protection.enabled === true) {
-    return branch.protection.required_status_checks?.contexts ?? []
+    return branch.protection.required_status_checks?.checks ?? []
   }
 
   return []

diff --git a/src/types.ts b/src/types.ts
@@ -5,6 +5,12 @@ export type Octokit = ReturnType<typeof github.getOctokit>
 export type PullRequest = Awaited<ReturnType<Octokit['rest']['pulls']['get']>>['data']
 export type Review = Awaited<ReturnType<Octokit['rest']['pulls']['getReview']>>['data']
 
+export type Branch = Awaited<ReturnType<Octokit['rest']['repos']['getBranch']>>['data']
+export type RequiredStatusCheck = Exclude<
+  Branch['protection']['required_status_checks'],
+  undefined
+>['checks'][0]
+
 export type ReviewAuthorAssociation = Review['author_association']
 
 export type MergeMethod = 'merge' | 'squash' | 'rebase' | undefined