Adds better comments

Author: zgosalvez

dist/main/index.js

@@ -20,20 +20,32 @@ async function run() {
 
     const coverageFile = await mergeCoverages(coverageFiles, tmpPath);
     const summary = await summarize(coverageFile);
+    const totalCoverage = lcovTotal(coverageFile);
+    const minimumCoverage = core.getInput('minimum-coverage');
     const gitHubToken = core.getInput('github-token').trim();
+    const errorMessage = `The code coverage is too low. Expected at least ${minimumCoverage}.`;
+    const isFailure = totalCoverage < minimumCoverage;
 
     if (gitHubToken !== '' && github.context.eventName === 'pull_request') {
+      const sha = github.context.payload.pull_request.head.sha;
+      const shaShort = sha.substr(0, 7);
+      let body = `### [LCOV](https://github.com/marketplace/actions/report-lcov) of commit [<code>${shaShort}</code>](${github.context.payload.pull_request.number}/commits/${sha}) during [${github.context.workflow} #${github.context.runNumber}](../actions/runs/${github.context.runId})\n<pre>${summary}</pre>`;
+
+      if (isFailure) {
+        body += `\n:no_entry: ${errorMessage}`;
+      }
+
       await github.getOctokit(gitHubToken)
         .issues.createComment({
           owner: github.context.repo.owner,
           repo: github.context.repo.repo,
           issue_number: github.context.payload.pull_request.number,
-          body: `<pre>${summary}</pre>`,
+          body: body,
         });
     }
 
-    if (lcovTotal(coverageFile) < core.getInput('minimum-coverage')) {
-      throw new Error('The code coverage is too low.');
+    if (isFailure) {
+      throw Error(errorMessage);
     }
   } catch (error) {
     core.setFailed(error.message);
@@ -104,7 +116,7 @@ async function summarize(coverageFile) {
   const lines = output
     .trim()
     .split(/\r?\n/)
-  
+
   lines.shift(); // Removes "Reading tracefile..."
 
   return lines.join('\n');