C H E C K S A P I S U P P O R T 🤩

index.js

@@ -2,7 +2,7 @@ const getDCOStatus = require('./lib/dco.js')
 const requireMembers = require('./lib/requireMembers.js')
 
 module.exports = app => {
-  app.on(['pull_request.opened', 'pull_request.synchronize'], check)
+  app.on(['pull_request.opened', 'pull_request.synchronize', 'check_run.rerequested'], check)
 
   async function check (context) {
     const config = await context.config('dco.yml', {
@@ -19,13 +19,73 @@ module.exports = app => {
       head: pr.head.sha
     }))
 
-    const dcoParams = await getDCOStatus(compare.data.commits, requireMembers(requireForMembers, context))
+    const commits = compare.data.commits
+    const dcoFailed = await getDCOStatus(commits, requireMembers(requireForMembers, context), context.issue())
 
-    const params = Object.assign({
-      sha: pr.head.sha,
-      context: 'DCO'
-    }, dcoParams)
+    if (!dcoFailed.length) {
+      return context.github.checks.create(context.repo({
+        name: 'DCO',
+        head_branch: pr.head.ref,
+        head_sha: pr.head.sha,
+        status: 'completed',
+        conclusion: 'success',
+        completed_at: new Date(),
+        output: {
+          title: 'DCO',
+          summary: 'All commits are signed off!'
+        }
+      }))
+    } else {
+      let summary = []
+      dcoFailed.forEach(function (commit) {
+        summary.push(`Commit sha: [${commit.sha.substr(0, 7)}](${commit.url}), Author: ${commit.author}, Committer: ${commit.committer}; ${commit.message}`)
+      })
+      summary = summary.join('\n')
+      if (dcoFailed.length === 1) summary = handleOneCommit(pr, dcoFailed) + `\n\n${summary}`
+      else summary = handleMultipleCommits(pr, commits.length, dcoFailed) + `\n\n${summary}`
 
-    return context.github.repos.createStatus(context.repo(params))
+      return context.github.checks.create(context.repo({
+        name: 'DCO',
+        head_branch: pr.head.ref,
+        head_sha: pr.head.sha,
+        status: 'completed',
+        conclusion: 'action_required',
+        completed_at: new Date(),
+        output: {
+          title: 'DCO',
+          summary
+        },
+        actions: [{
+          label: 'Set DCO to pass',
+          description: 'would set status to passing',
+          identifier: `override`
+        }]
+      }))
+    }
   }
+
+  // This option is only presented to users with Write Access to the repo
+  app.on('check_run.requested_action', setStatusPass)
+  async function setStatusPass (context) {
+    return context.github.checks.create(context.repo({
+      name: 'DCO',
+      head_branch: context.payload.check_run.check_suite.head_branch,
+      head_sha: context.payload.check_run.head_sha,
+      status: 'completed',
+      conclusion: 'success',
+      completed_at: new Date(),
+      output: {
+        title: 'DCO',
+        summary: 'Commit sign-off was manually approved.'
+      }
+    }))
+  }
+}
+
+function handleOneCommit (pr, dcoFailed) {
+  return `You only have one commit incorrectly signed off! To fix, head to your local branch and run: \n\`\`\`bash\ngit commit --amend --signoff\n\`\`\`\nNow your commits will have your sign off. Next run \n\`\`\`bash\ngit push --force origin ${pr.head.ref}\n\`\`\``
+}
+
+function handleMultipleCommits (pr, commitLength, dcoFailed) {
+  return `You only have ${dcoFailed.length} commits incorrectly signed off! To fix, head to your local branch and run: \n\`\`\`bash\ngit rebase HEAD~${commitLength} --signoff\n\`\`\`\n Now your commits will have your sign off. Next run \n\`\`\`bash\ngit push --force origin ${pr.head.ref}\n\`\`\``
 }

lib/dco.js

@@ -1,18 +1,13 @@
 const validator = require('email-validator')
 
-// Returns the DCO object containing state and description
-// Also returns target_url (in case of failure) in object
-module.exports = async function (commits, isRequiredFor) {
+// Returns a list containing failed commit error messages
+// If commits aren't properly signed signed off
+// Otherwise returns an empty list
+module.exports = async function (commits, isRequiredFor, prInfo) {
   const regex = /^Signed-off-by: (.*) <(.*)>$/im
-  const failure = (description) => {
-    return {
-      state: 'failure',
-      description: description.substring(0, 140),
-      target_url: 'https://github.com/probot/dco#how-it-works'
-    }
-  }
+  let failed = []
 
-  for (const {commit, author, parents} of commits) {
+  for (const {commit, author, parents, sha} of commits) {
     const isMerge = parents && parents.length > 1
     const signoffRequired = !author || await isRequiredFor(author.login)
     if (isMerge || (!signoffRequired && commit.verification.verified)) {
@@ -22,23 +17,34 @@ module.exports = async function (commits, isRequiredFor) {
     }
     const match = regex.exec(commit.message)
 
+    const commitInfo = {
+      sha,
+      url: `https://github.com/${prInfo.owner}/${prInfo.repo}/pull/${prInfo.number}/commits/${sha}`,
+      author: commit.author.name,
+      committer: commit.committer.name,
+      message: ''
+    }
+
     if (match === null) {
-      if (signoffRequired) return failure(`The sign-off is missing.`)
-      if (!commit.verification.verified) return failure(`Commit by organization member is not verified.`)
+      if (signoffRequired) {
+        commitInfo['message'] = `The sign-off is missing.`
+        failed.push(commitInfo)
+      } else if (!commit.verification.verified) {
+        commitInfo['message'] = `Commit by organization member is not verified.`
+        failed.push(commitInfo)
+      }
     } else {
       if (!(validator.validate(commit.author.email || commit.committer.email))) {
-        return failure(`${commit.author.email} is not a valid email address.`)
+        commitInfo['message'] = `${commit.author.email} is not a valid email address.`
+        failed.push(commitInfo)
       }
       const authors = [commit.author.name.toLowerCase(), commit.committer.name.toLowerCase()]
       const emails = [commit.author.email.toLowerCase(), commit.committer.email.toLowerCase()]
       if (!(authors.includes(match[1].toLowerCase())) || !(emails.includes(match[2].toLowerCase()))) {
-        return failure(`Expected "${commit.author.name} <${commit.author.email}>", but got "${match[1]} <${match[2]}>".`)
+        commitInfo['message'] = `Expected "${commit.author.name} <${commit.author.email}>", but got "${match[1]} <${match[2]}>".`
+        failed.push(commitInfo)
       }
     }
   }
-  return {
-    state: 'success',
-    description: 'All commits have a DCO sign-off from the author',
-    target_url: 'https://github.com/probot/dco#how-it-works'
-  }
+  return failed
 }