feat(ci): add code coverage reports on PRs

relates to STACKITTPR-162

Author: rubenhoenle

.github/workflows/ci.yaml

@@ -4,6 +4,8 @@ on: [pull_request, workflow_dispatch]
 
 env:
   GO_VERSION: "1.24"
+  CODE_COVERAGE_FILE_NAME: "coverage.out" # must be the same as in Makefile
+  CODE_COVERAGE_ARTIFACT_NAME: "code-coverage"
 
 jobs:
   main:
@@ -29,10 +31,33 @@ jobs:
 
       - name: Lint
         run: make lint
-      
+
+      # note: test make task creates the coverage.out file
       - name: Test
         run: make test
 
+      - name: Upload code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.CODE_COVERAGE_ARTIFACT_NAME }}
+          path: ${{ env.CODE_COVERAGE_FILE_NAME }}
+
+  code_coverage:
+    name: "Code coverage report"
+    if: ${{ github.event_name == 'pull_request' }}
+    runs-on: ubuntu-latest
+    needs: [main]
+    permissions:
+      contents: read
+      actions: read  # to download code coverage results from "test" job
+      pull-requests: write # write permission needed to comment on PR
+    steps:
+      - name: Add code coverage report comment to PR
+        uses: fgrosse/go-coverage-report@v1.2.0
+        with:
+          coverage-artifact-name: ${{ env.CODE_COVERAGE_ARTIFACT_NAME }}
+          coverage-file-name: ${{ env.CODE_COVERAGE_FILE_NAME }}
+
   config:
     name: Check GoReleaser config
     runs-on: ubuntu-latest

CONTRIBUTION.md

@@ -25,8 +25,7 @@ These commands can be executed from the project root:
 - `make project-tools`: get the required dependencies
 - `make lint`: lint the code and examples
 - `make generate-docs`: generate terraform documentation
-- `make test`: run unit tests
-- `make coverage`: create unit test coverage report (output file: `stackit/coverage.html`)
+- `make test`: run unit tests and create unit test coverage report (output file: `stackit/coverage.html`)
 - `make test-acceptance-tf`: run acceptance tests
 
 ### Repository structure

Makefile

@@ -35,12 +35,7 @@ fmt:
 # TEST
 test:
 	@echo "Running tests for the terraform provider"
-	@cd $(ROOT_DIR)/stackit && go test ./... -count=1 && cd $(ROOT_DIR)
-
-# Test coverage
-coverage:
-	@echo ">> Creating test coverage report for the terraform provider"
-	@cd $(ROOT_DIR)/stackit && (go test ./... -count=1 -coverprofile=coverage.out || true) && cd $(ROOT_DIR)
+	@cd $(ROOT_DIR)/stackit && (go test ./... -count=1 -coverprofile=coverage.out) && cd $(ROOT_DIR)
 	@cd $(ROOT_DIR)/stackit && go tool cover -html=coverage.out -o coverage.html && cd $(ROOT_DIR)
 
 test-acceptance-tf: