summary

.vscode/settings.json

@@ -1,6 +1,3 @@
 {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "[javascript]": {
-      "editor.defaultFormatter": "esbenp.prettier-vscode"
-    }
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
 }

package.json

@@ -26,7 +26,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.6.0",
+    "@actions/core": "^1.10.0",
     "@actions/github": "^5.0.0",
     "markdown-table": "^3.0.2"
   },

src/compareCommits.ts

@@ -11,11 +11,9 @@ export async function compareCommits(base: string, head: string): Promise<Commit
   const response = await octokit.rest.repos.compareCommits({base, head, owner, repo})
 
   const files = response.data.files ?? []
-
   const newFiles: string[] = []
   const modifiedFiles: string[] = []
 
-  // Also  uncommon to write for loops in JS these days - unless you want async tasks to run sequentally
   for (const file of files) {
     if (file.status === 'added') newFiles.push(file.filename)
     if (file.status === 'modified') modifiedFiles.push(file.filename)

src/index.ts

@@ -2,15 +2,10 @@ import * as core from '@actions/core'
 import {context} from '@actions/github'
 import {parseCoverageReport} from './coverage'
 import {compareCommits} from './compareCommits'
-import {messagePr} from './messagePr'
-import {octokit} from './client'
+import {scorePr} from './scorePr'
 import readFile from './readFile'
 
-const checkName = 'Coverage Results'
-
 async function run(): Promise<void> {
-  let checkId = -1
-
   try {
     const coverageFile: string = core.getInput('coverageFile', {required: true})
     core.debug(`coverageFile: ${coverageFile}`)
@@ -24,81 +19,21 @@ async function run(): Promise<void> {
     const base = pull_request?.base.sha
     const head = pull_request?.head.sha
 
-    checkId = await getCheck(head)
-
     core.info(`comparing commits: base ${base} <> head ${head}`)
     const files = await compareCommits(base, head)
     core.info(`git new files: ${JSON.stringify(files.newFiles)} modified files: ${JSON.stringify(files.modifiedFiles)}`)
 
     const report = readFile(coverageFile)
     const filesCoverage = parseCoverageReport(report, files)
-    const {passOverall, message} = messagePr(filesCoverage)
-
-    const status = 'completed'
-    const conclusion = passOverall ? 'success' : 'failure'
-
-    if (checkId > 0) {
-      octokit.rest.checks.update({
-        ...context.repo,
-        check_run_id: checkId,
-        status,
-        conclusion,
-        output: {title: 'Coverage Results - ', summary: message}
-      })
-    }
+    const passOverall = scorePr(filesCoverage)
 
     if (!passOverall) {
       core.setFailed('Coverage is lower then configured threshold 😭')
     }
   } catch (error) {
     const message = JSON.stringify(error instanceof Error ? error.message : error)
     core.setFailed(message)
-    if (checkId > 0) {
-      octokit.rest.checks.update({
-        ...context.repo,
-        check_run_id: checkId,
-        status: 'completed',
-        conclusion: 'failure',
-        output: {title: 'Coverage Results Failed - ', summary: message}
-      })
-    }
   }
 }
 
 run()
-
-async function getCheck(head: string): Promise<number> {
-  const checks = await octokit.rest.checks.listForRef({
-    ...context.repo,
-    ref: head
-  })
-
-  const existingCheck = checks.data?.check_runs?.find(check => check.name === checkName)
-
-  let checkId = -1
-
-  try {
-    if (existingCheck) {
-      checkId = existingCheck.id
-      core.info(`existing checkId: ${checkId}`)
-      await octokit.rest.checks.update({
-        ...context.repo,
-        check_run_id: checkId,
-        status: 'in_progress'
-      })
-    } else {
-      const respond = await octokit.rest.checks.create({
-        ...context.repo,
-        head_sha: head,
-        name: checkName,
-        status: 'in_progress'
-      })
-      checkId = respond.data.id
-      core.info(`new checkId: ${checkId}`)
-    }
-  } catch (e) {
-    core.warning('could not create a check - you might be running from a fork or token has no write permission')
-  }
-
-  return checkId
-}

src/messagePr.ts → src/scorePr.ts

@@ -7,17 +7,18 @@ import {markdownTable} from 'markdown-table'
 import {octokit} from './client'
 
 const passOrFailIndicator = (predicate: boolean): string => (predicate ? '🟢' : '🔴')
+const TITLE = `# ☂️ Python Cov`
 
 export async function publishMessage(pr: number, message: string): Promise<void> {
-  const title = `# ☂️ Python Cov`
-  const body = title.concat(message)
+  const body = TITLE.concat(message)
+  core.summary.addRaw(body).write()
 
   const comments = await octokit.rest.issues.listComments({
     ...context.repo,
     issue_number: pr
   })
   const exist = comments.data.find(commnet => {
-    return commnet.body?.startsWith(title)
+    return commnet.body?.startsWith(TITLE)
   })
 
   if (exist) {
@@ -75,12 +76,12 @@ function formatAverageTable(cover: AverageCoverage): {coverTable: string; pass:
   return {coverTable, pass: cover.pass}
 }
 
-export function messagePr(filesCover: FilesCoverage): {passOverall: boolean; message: string} {
+export function scorePr(filesCover: FilesCoverage): boolean {
   let message = ''
   let passOverall = true
 
-  const {coverTable: avgCoverTable, pass: passTotal} = formatAverageTable(filesCover.averageCover)
   core.startGroup('Results')
+  const {coverTable: avgCoverTable, pass: passTotal} = formatAverageTable(filesCover.averageCover)
   message = message.concat(`\n## Overall Coverage\n${avgCoverTable}`)
   passOverall = passOverall && passTotal
   const coverAll = toPercent(filesCover.averageCover.ratio)
@@ -112,5 +113,5 @@ export function messagePr(filesCover: FilesCoverage): {passOverall: boolean; mes
   publishMessage(context.issue.number, message)
   core.endGroup()
 
-  return {passOverall, message}
+  return passOverall
 }