Cleanup

Author: Tofandel

.github/workflows/test.yml

@@ -20,10 +20,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Set Node.js 21.x
+      - name: Set Node.js 22.x
         uses: actions/setup-node@v3
         with:
-          node-version: 21.x
+          node-version: 22.x
 
       - name: Install dependencies
         run: npm ci

__tests__/utils/github.test.ts

@@ -65,6 +65,25 @@ test('build annotations', function () {
       message: 'This line is not covered by a test'
     }
   ])
+
+  const consoleMock = jest.spyOn(console, 'log').mockImplementation()
+
+  githubUtil.annotate(annotations)
+  expect(console.log).toHaveBeenCalledTimes(4)
+  expect(console.log).toHaveBeenCalledWith(
+    '::warning file=file1.txt,line=132,endLine=132::This line is not covered by a test'
+  )
+  expect(console.log).toHaveBeenCalledWith(
+    '::warning file=file1.txt,line=134,endLine=136::These lines are not covered by a test'
+  )
+  expect(console.log).toHaveBeenCalledWith(
+    '::warning file=file1.txt,line=1007,endLine=1007::This line is not covered by a test'
+  )
+  expect(console.log).toHaveBeenCalledWith(
+    '::warning file=test/dir/file1.txt,line=22,endLine=22::This line is not covered by a test'
+  )
+
+  consoleMock.mockRestore()
 })
 
 // @todo test for rest of github class

dist/index.js

@@ -1,7 +1,7 @@
 import {env} from 'node:process'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {filterCoverageByFile} from './utils/general'
+import {CoverageParsed, filterCoverageByFile} from './utils/general'
 import {parseLCov} from './utils/lcov'
 import {parseClover} from './utils/clover'
 import {parseGoCoverage} from './utils/gocoverage'
@@ -46,15 +46,16 @@ export async function play(): Promise<void> {
     const workspacePath = env.GITHUB_WORKSPACE || ''
     core.info(`Workspace: ${workspacePath}`)
 
+    let parsedCov: CoverageParsed
     // 1. Parse coverage file
     if (COVERAGE_FORMAT === 'clover') {
-      var parsedCov = await parseClover(COVERAGE_FILE_PATH, workspacePath)
+      parsedCov = await parseClover(COVERAGE_FILE_PATH, workspacePath)
     } else if (COVERAGE_FORMAT === 'go') {
       // Assuming that go.mod is available in working directory
-      var parsedCov = await parseGoCoverage(COVERAGE_FILE_PATH, 'go.mod')
+      parsedCov = await parseGoCoverage(COVERAGE_FILE_PATH, 'go.mod')
     } else {
       // lcov default
-      var parsedCov = await parseLCov(COVERAGE_FILE_PATH, workspacePath)
+      parsedCov = await parseLCov(COVERAGE_FILE_PATH, workspacePath)
     }
     // Sum up lines.found for each entry in parsedCov
     const totalLines = parsedCov.reduce(
@@ -91,10 +92,7 @@ export async function play(): Promise<void> {
     )
 
     // 4. Annotate in github
-    await githubUtil.annotate({
-      referenceCommitHash: githubUtil.getPullRequestRef(),
-      annotations
-    })
+    githubUtil.annotate(annotations)
     core.info('Annotation done')
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)

dist/index.js.map

@@ -46,19 +46,14 @@ export class GithubUtil {
   }
 
   /**
-   * https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
-   * https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#update-a-check-run
+   * https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-warning-message
    */
-  async annotate(input: InputAnnotateParams): Promise<number> {
-    if (input.annotations.length === 0) {
-      return 0
-    }
-    for (const ann of input.annotations) {
+  annotate(annotations: Annotations[]): void {
+    for (const ann of annotations) {
       console.log(
-        `::warning file=${ann.path},line=${ann.start_line},endLine=${ann.end_line}::${ann.message}`
+        `::${ann.annotation_level} file=${ann.path},line=${ann.start_line},endLine=${ann.end_line}::${ann.message}`
       )
     }
-    return 0
   }
 
   buildAnnotations(
@@ -97,11 +92,6 @@ export class GithubUtil {
   }
 }
 
-type InputAnnotateParams = {
-  referenceCommitHash: string
-  annotations: Annotations[]
-}
-
 type Annotations = {
   path: string
   start_line: number