fix: fix go.yml

.github/workflows/go.yml

@@ -1,31 +1,55 @@
-# This workflow will build a golang project
+name: CI
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
-
-name: Go
 
+# This setup assumes that you run the unit tests with code coverage in the same
+# workflow that will also print the coverage report as comment to the pull request. 
+# Therefore, you need to trigger this workflow when a pull request is (re)opened or
+# when new code is pushed to the branch of the pull request. In addition, you also
+# need to trigger this workflow when new code is pushed to the main branch because 
+# we need to upload the code coverage results as artifact for the main branch as
+# well since it will be the baseline code coverage.
+# 
+# We do not want to trigger the workflow for pushes to *any* branch because this
+# would trigger our jobs twice on pull requests (once from "push" event and once
+# from "pull_request->synchronize")
 on:
-  push:
-    branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
+    types: [opened, reopened, synchronize]
+  push:
+    branches:
+      - 'main'
 
 jobs:
-
+  unit_tests:
-  build:
+    name: "Unit tests"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
-        go-version: '1.20'
+          go-version: ^1.22
-
-    - name: Build
-      run: go build -v ./...
 
+      # When you execute your unit tests, make sure to use the "-coverprofile" flag to write a 
+      # coverage profile to a file. You will need the name of the file (e.g. "coverage.txt")
+      # in the next step as well as the next job.
       - name: Test
-      run: go test -v ./...
+        run: go test -cover -coverprofile=coverage.txt ./...
 
-    - name: Go Unit Test Coverage Report
+      - name: Archive code coverage results
-      uses: fgrosse/go-coverage-report@v1.0.2
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage
+          path: coverage.txt # Make sure to use the same file name you chose for the "-coverprofile" in the "Test" step
+
+  code_coverage:
+    name: "Code coverage report"
+    if: github.event_name == 'pull_request' # Do not run when workflow is triggered by push to main branch
+    runs-on: ubuntu-latest
+    needs: unit_tests # Depends on the artifact uploaded by the "unit_tests" job
+    steps:
+      - uses: fgrosse/go-coverage-report@v1.0.2 # Consider using a Git revision for maximum security
+        with:
+          coverage-artifact-name: "code-coverage" # can be omitted if you used this default value
+          coverage-file-name: "coverage.txt" # can be omitted if you used this default value