Configurable approvals and labels when Codeball has approved a contribution

Author: zegl

.github/workflows/codeball.yml

@@ -1,10 +1,9 @@
 on: [pull_request]
-
+name: Codeball
 jobs:
   codeball_job:
     runs-on: ubuntu-latest
     name: Run Codeball
     steps:
       - name: Codeball AI Actions
         uses: sturdy-dev/codeball-action@v1
-

README.md

@@ -4,10 +4,9 @@
 
 ![github_bg](https://user-images.githubusercontent.com/47952/170700847-bb0cac65-f269-4758-955a-632c48f47290.png)
 
-
 **Save time and $$$, use Codeball to perform an early review of all your code.**
 
-* [Online Demo](https://codeball.ai/)
+- [Online Demo](https://codeball.ai/)
 
 ## Quick Start
 

action.yml

@@ -1,4 +1,4 @@
-# See https://github.com/sturdy-dev/codeball-action for more information of how to use this aciont
+# See https://github.com/sturdy-dev/codeball-action for more information of how to use this action
 name: Codeball AI Actions
 description: AI Code Review
 
@@ -7,8 +7,22 @@ branding:
   icon: check
   color: orange
 
+inputs:
+  do-label:
+    description: 'If "true", the action will label Pull Request if Codeball AI approves the contribution'
+    default: "true"
+    required: false
+  label-name:
+    description: 'Label value to be set.'
+    default: 'codeball:approved'
+    required: false
+  do-approve:
+    description: 'If "true", the action will submit an approving Pull Request review if Codeball AI approves the contribution'
+    default: "true"
+    required: false
+
 runs:
-  using: "composite"
+  using: 'composite'
   steps:
     # Start a new Codeball review job
     # This step is asynchronous and will return a job id
@@ -23,3 +37,6 @@ runs:
       uses: sturdy-dev/codeball-action/approver@v1
       with:
         codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}
+        do-label: ${{ inputs.do-label }}
+        label-name: ${{ inputs.label-name }}
+        do-approve: ${{ inputs.do-approve }}

approver/action.yml

@@ -1,8 +1,10 @@
 name: 'Codeball Approver'
 description: 'Codeball Approver (beta)'
+
 branding:
   icon: check
   color: orange
+
 inputs:
   GITHUB_TOKEN:
     description: 'Default to {{ github.token }}. This is the default GitHub token available to actions and is used to run Codeball and to post the result. The default token permissions (https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#permissions) work fine.'
@@ -11,6 +13,19 @@ inputs:
   codeball-job-id:
     description: 'The ID of the Codeball Job created by the Baller Action'
     required: true
+  do-label:
+    description: 'If "true", the action will label Pull Request if Codeball AI approves the contribution'
+    default: "true"
+    required: false
+  label-name:
+    description: 'Label value to be set.'
+    default: 'codeball:approved'
+    required: false
+  do-approve:
+    description: 'If "true", the action will submit an approving Pull Request review if Codeball AI approves the contribution'
+    default: "true"
+    required: false
+
 runs:
   using: 'node16'
-  main: '../dist/approver/index.js'
+  main: '../dist/approver/index.js'

src/approver/main.ts

@@ -1,6 +1,6 @@
 import fetch from 'node-fetch'
 import {Job} from './types'
-import {isContributionJob, isFinalStatus} from './utils'
+import { isContributionJob, isFinalStatus } from "./utils";
 
 async function getJob(id: string): Promise<Job> {
   const res = await fetch(`https://api.codeball.ai/jobs/${id}`)
@@ -10,20 +10,33 @@ async function getJob(id: string): Promise<Job> {
 
 async function run(): Promise<void> {
   const core = require('@actions/core')
-
   try {
     const github = require('@actions/github')
     const {Octokit} = require('@octokit/action')
 
     const pullRequestURL = github.context.payload?.pull_request?.html_url
-
     if (!pullRequestURL) {
-      core.setFailed('No pull request URL found')
-      return
+      throw new Error('No pull request URL found')
+    }
+
+    const pullRequestNumber = github.context.payload?.pull_request?.number
+    if (!pullRequestNumber) {
+      throw new Error('No pull request number found')
+    }
+
+    const commitId = github.context.payload.pull_request?.head.sha
+    if (!commitId) {
+      throw new Error('No commit ID found')
     }
 
     const jobID = core.getInput('codeball-job-id')
+    const doApprove = core.getInput('do-approve') === 'true'
+    const doLabel = core.getInput('do-label') === 'true'
+    const labelName = core.getInput('label-name')
+
     core.info(`Job ID: ${jobID}`)
+    core.info(`Do approve: ${doApprove}`)
+    core.info(`Do label: ${doLabel} with value: ${labelName}`)
 
     let job = await getJob(jobID)
     let attempts = 0
@@ -38,33 +51,71 @@ async function run(): Promise<void> {
     }
 
     if (!isFinalStatus(job.status)) {
-      core.setFailed(`Job ${jobID} is not finished`)
-      return
+      throw new Error(`Job ${jobID} is not finished`)
     }
 
     if (!isContributionJob(job)) {
-      core.setFailed(`Job ${jobID} is not a contribution job`)
-      return
+      throw new Error(`Job ${jobID} is not a contribution job`)
     }
 
     const approved = job.contribution?.result === 'approved'
 
+    const octokit = new Octokit()
     if (approved) {
       core.info(`Job ${jobID} is approved, approving the PR now!`)
 
-      const octokit = new Octokit()
+      if (doLabel) {
+        core.debug(`Adding label "${labelName}" to PR ${pullRequestURL}`)
 
-      await octokit.request(
-        'POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews',
-        {
-          owner: github.context.payload.organization.login,
-          repo: github.context.payload.repository.name,
-          pull_number: github.context.payload.pull_request.number,
-          commit_id: github.context.payload.pull_request.head.sha,
+        const existingLabels = await octokit.issues.listLabelsForRepo({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo
+        })
+
+        let haveLabel = false
+        for (const label of existingLabels.data) {
+          if (label.name === labelName) {
+            haveLabel = true
+            break
+          }
+        }
+
+        if (!haveLabel) {
+          core.info(
+            `Label "${labelName}" does not exist, creating it now`
+          )
+          await octokit.issues.createLabel({
+            owner: github.context.repo.owner,
+            repo: github.context.repo.repo,
+            name: labelName,
+            color: '008E43',
+            description: 'Codeball approved this pull request'
+          })
+        } else {
+          core.debug(
+            `Label "${labelName}" already exists, will not create it`
+          )
+        }
+
+        await octokit.issues.addLabels({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo,
+          issue_number: pullRequestNumber,
+          labels: [labelName]
+        })
+      }
+
+      if (doApprove) {
+        core.debug(`Approving PR ${pullRequestURL}`)
+        await octokit.pulls.createReview({
+          owner: github.context.repo.owner,
+          repo: github.context.repo.repo,
+          pull_number: pullRequestNumber,
+          commit_id: commitId,
           body: 'Codeball: LGTM! :+1:',
           event: 'APPROVE'
-        }
-      )
+        })
+      }
     } else {
       core.info(`Job ${jobID} is not approved, will not approve the PR`)
     }
@@ -76,15 +127,9 @@ async function run(): Promise<void> {
           {data: 'Pull Request', header: true},
           {data: 'Result', header: true}
         ],
-        [
-          `#${github.context.payload.pull_request.number}`,
-          approved ? 'Approved ✅' : 'Not approved'
-        ]
+        [`#${pullRequestNumber}`, approved ? 'Approved ✅' : 'Not approved']
       ])
-      .addLink(
-        'View on web',
-        `https://codeball.ai/prediction/${jobID}`
-      )
+      .addLink('View on web', `https://codeball.ai/prediction/${jobID}`)
       .write()
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)