status: expose confidence

Author: zegl

Diff for: src/lib/jobs/types.ts

@@ -54,9 +54,14 @@ export type Contribution = {
   created_at: string
   merged_at: any
   result: 'inconclusive' | 'approved' | 'not_approved' | null
+  predicted_outcome?: PredictedOutcome
 }
 
 export type Comment = {
   url: string
   suggestions: Suggestion[]
 }
+
+export type PredictedOutcome = {
+  file_probabilities?: number[]
+}

Diff for: src/status/main.ts

@@ -29,9 +29,23 @@ const getJobType = (job: Job): string => {
   return 'unknown'
 }
 
+const getConfidence = (job: Job): number => {
+  if (isContributionJob(job)) {
+    const probabilities =
+      job.contribution?.predicted_outcome?.file_probabilities || []
+    return Math.min(...probabilities)
+  }
+  return 0
+}
+
 const run = async (
   jobID: string
-): Promise<{isApproved: boolean; isSuggested: boolean; jobType: string}> => {
+): Promise<{
+  isApproved: boolean
+  isSuggested: boolean
+  jobType: string
+  confidence: number
+}> => {
   core.info(`Job ID: ${jobID}`)
 
   let job = await get(jobID)
@@ -49,18 +63,20 @@ const run = async (
   return {
     isApproved: isApproved(job),
     isSuggested: isSuggested(job),
-    jobType: getJobType(job)
+    jobType: getJobType(job),
+    confidence: getConfidence(job)
   }
 }
 
 const jobID = required('codeball-job-id')
 
 run(jobID)
-  .then(async ({isApproved, isSuggested, jobType}) => {
+  .then(async ({isApproved, isSuggested, jobType, confidence}) => {
     await track({jobID, actionName: 'status'})
     core.setOutput('approved', isApproved)
     core.setOutput('suggested', isSuggested)
     core.setOutput('jobType', jobType)
+    core.setOutput('confidence', confidence)
   })
   .catch(async error => {
     if (error instanceof Error) {

Diff for: status/README.md

@@ -10,10 +10,20 @@ The ID of the Codeball Job created by the Baller Action
 
 # Outputs
 
+## `jobType`
+
+`"contribution"` or `"comment`
+
 ## `approved`
 
 If the Codeball approved the contribution (true or false)
 
 ## `suggested`
 
 If the Codeball has suggestions for the contribution (true or false)
+
+## `confidence`
+
+The Codeball confidence that this contribution can be approved as-is. A number between 0 and 1. A value between 0 and 0.3 normally indicates that the contribution should be thoroughly reviewed. A value above 0.93 indicates that the contribution is very likely to be approved as-is.
+
+Confidence is only set for contribution jobs.

Diff for: status/action.yml

@@ -17,6 +17,8 @@ outputs:
     description: 'If the Codeball approved the contribution (true or false)'
   suggested:
     description: 'If the Codeball has suggestions for the contribution (true or false)'
+  confidence:
+    description: 'The Codeball confidence that this contribution can be approved as-is. A number between 0 and 1. A value between 0 and 0.3 normally indicates that the contribution should be thoroughly reviewed. A value above 0.93 indicates that the contribution is very likely to be approved as-is. Confidence is only set for contribution jobs.'
 
 runs:
   using: 'node16'