Merge pull request #359 from johndarmstrong/feature/comment-format

add terse comments to avoid GH issue body limits

Author: dkhunt27

action.yml

@@ -58,6 +58,9 @@ inputs:
   cache-seconds:
     description: 'The cache lifetime in seconds (must be greater than 300)'
     required: false
+  comment-format:
+    description: 'The format of the github comment "verbose" or "concise"'
+    required: false
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -8,7 +8,7 @@ const renderEmoji = (diff: number): string => {
   return '✅'
 }
 
-export const buildComment = ({results}: BuildCommentInputs): string => {
+export const buildComment = ({results, format}: BuildCommentInputs): string => {
   const html = results.map(result => {
     let plus = ''
     let arrow = ''
@@ -52,9 +52,16 @@ export const buildComment = ({results}: BuildCommentInputs): string => {
       coverage = result.coverage.toFixed(2)
     }
 
-    return `${table(
-      tbody(tr(th(result.app), th(coverage, '%'), diffHtml))
-    )} \n\n ${details(summary('Coverage Report'), htmlResults)} <br/>`
+    switch (format) {
+      case 'concise':
+        return `${table(
+          tbody(tr(th(result.app), th(coverage, '%'), diffHtml))
+        )} <br/>`
+      default:
+        return `${table(
+          tbody(tr(th(result.app), th(coverage, '%'), diffHtml))
+        )} \n\n ${details(summary('Coverage Report'), htmlResults)} <br/>`
+    }
   })
 
   const title = `Code Coverage:<p></p>`

dist/index.js.map

@@ -26,6 +26,8 @@ async function run(): Promise<void> {
     const gistProcessing = getBooleanInput('gist-processing')
     const gistToken = getInput('gist-token', {required: false}) || undefined
     const gistId = getInput('gist-id', {required: false}) || undefined
+    const commentFormat =
+      getInput('comment-format', {required: false}) || 'verbose'
 
     if (gistProcessing) {
       if (!gistToken || !gistId) {
@@ -42,7 +44,8 @@ async function run(): Promise<void> {
       githubWorkspace,
       gistProcessing,
       gistToken,
-      gistId
+      gistId,
+      commentFormat
     }
 
     await main(mainInputs)

src/comment.ts

@@ -16,6 +16,7 @@ export interface MainInputs {
   gistProcessing: boolean
   gistId?: string
   gistToken?: string
+  commentFormat?: string
 }
 
 export interface UpsertCommentInputs {
@@ -49,6 +50,7 @@ export interface ListCoverageFilesInputs {
 
 export interface BuildCommentInputs {
   results: JcsMergedType[]
+  format?: string
 }
 
 export interface MergeFileListsInputs {

src/index.ts

@@ -20,7 +20,8 @@ export const main = async ({
   githubWorkspace,
   gistProcessing,
   gistToken,
-  gistId
+  gistId,
+  commentFormat
 }: MainInputs): Promise<JcsMergedType[]> => {
   try {
     // hiddenHeader to help identify any previous PR comments
@@ -48,7 +49,7 @@ export const main = async ({
           2
         )}`
       )
-      commentBody = buildComment({results})
+      commentBody = buildComment({results, format: commentFormat})
       hiddenHeader = hiddenHeaderForCoverage
     } else {
       logWarn(