ci: onboard codecov

.codecov.yaml

@@ -0,0 +1,41 @@
+# Config can be validated before merging: curl -X POST --data-binary @.codecov.yaml https://codecov.io/validate
+codecov:
+  max_report_age: "off"  # see https://docs.codecov.io/docs/codecov-yaml#section-expired-reports
+
+# See http://docs.codecov.io/docs/coverage-configuration
+coverage:
+  precision: 2  # 2 = xx.xx%, 0 = xx%
+  round: down
+  # For example: 20...60 would result in any coverage less than 20%
+  # would have a red background. The color would gradually change to
+  # green approaching 60%. Any coverage over 60% would result in a
+  # solid green color.
+  range: "20...60"
+
+  # See https://docs.codecov.com/docs/commit-status
+  status:
+    # project will give us the diff in the total code coverage between a commit
+    # and its parent
+    project:
+      default:
+        # Allow the coverage to drop by 1%, and posting a success status.
+        threshold: 1%
+    # Patch gives just the coverage of the patch
+    patch: yes
+    # changes tells us if there are unexpected code coverage changes in other files
+    # which were not changed by the diff
+    changes: yes
+
+  # See http://docs.codecov.io/docs/ignoring-paths
+  ignore:
+    - "cmd/*"
+    - "test/*"
+
+# See http://docs.codecov.io/docs/pull-request-comments-1
+comment:
+  layout: "header, diff, tree"
+  # default = posts once then update, posts new if delete
+  # once = post once then updates
+  # new = delete old, post new
+  # spammy = post new
+  behavior: "new"

.github/workflows/ci.yml

@@ -28,6 +28,12 @@ jobs:
     - name: Test
       run: |
         task test
+
+    - name: Upload coverage artifact
+      uses: actions/upload-artifact@v7
+      with:
+        name: coverage
+        path: ./build/_output/coverage/coverage.txt    
 
     - name: Install Podman
       uses: redhat-actions/podman-install@main

.github/workflows/upload-coverage.yml

@@ -0,0 +1,30 @@
+name: upload-coverage
+on:
+  workflow_run:
+    workflows: [ ci ]
+    types: [ completed ]
+
+jobs:
+  upload-coverage:
+    if: >
+      github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Download coverage artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: coverage
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v6
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          # The 'files' attribute consists of 'coverage/coverage.txt'.
+          # The 'coverage' directory is created upon the download of the coverage artifact from previous step (it creates a directory with the name of the artifact).
+          files: coverage/coverage.txt
+          flags: unittests # optional
+          fail_ci_if_error: true    
+          verbose: true

.gitignore

@@ -1 +1,2 @@
 tmp
+build/_output/**

taskfile.yaml

@@ -1,11 +1,24 @@
 version: '3'
 
+vars:
+  OUT_DIR: ./build/_output
+  COV_DIR: ./build/_output/coverage
+
 tasks:
+  ensure-dirs:
+    cmds:
+      - mkdir -p {{.OUT_DIR}}
+    silent: true
+
   # Unit Tests
   test:
+    desc: Run tests with coverage
     cmds:
+      - echo "running the tests with coverage..."
+      - mkdir -p {{.COV_DIR}}
+      - rm -f {{.COV_DIR}}/coverage.txt
       # The idiomatic way to disable test caching explicitly is to use -count=1
-      - go test ./internal/... -count=1 -v --failfast
+      - go test ./internal/... -count=1 -v --failfast -coverprofile={{.COV_DIR}}/coverage.txt -covermode=atomic
 
   # Linting
   lint: