upload test coverage artifact

.github/workflows/build-test.yml

@@ -2,6 +2,8 @@ name: CI Build and Test
 
 on:
   workflow_call:
+  push:
+    branches: ['main']
   pull_request:
     branches: ['main']
 
@@ -27,3 +29,28 @@ jobs:
         run: go build -tags release -v ./...
       - name: Test
         run: make test
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage
+          path: coverage.out
+
+
+  # XXX this will fail if main does not already have a coverage.out report uploaded by the previous job
+  # TODO uncomment this after upload-artifact has run on main branch
+  # code-coverage:
+  #   name: Code coverage report
+  #   runs-on: ubuntu-latest
+  #   needs: build-and-test
+  #   steps:
+  #     - name: coverage report
+  #       id: coverage-report
+  #       uses: fgrosse/[email protected]
+  #       with:
+  #         coverage-file-name: coverage.out
+  #         skip-comment: true # requires write permissin on pull requests
+  #         # below options help track coverage across forks
+  #         trim: github.com/project-kessel/inventory-api
+  #         root-package: ""
+  #     - name: coverage summary
+  #       run: echo "${{ steps.coverage-report.outputs.coverage_report }}" >> "$GITHUB_STEP_SUMMARY"

.gitignore

@@ -10,6 +10,8 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+# HTML test coverage report produce with `go tool cover`
+coverage.html
 
 # Dependency directories (remove the comment below to include it)
 vendor/

Makefile

@@ -87,7 +87,10 @@ test:
 	@$(GO) test ./... -count=1 -coverprofile=coverage.out -skip 'TestInventoryAPIGRPC_*|TestInventoryAPIHTTP_*|Test_ACMKafkaConsumer'
 	@echo "Overall test coverage:"
 	@$(GO) tool cover -func=coverage.out | grep total: | awk '{print $$3}'
-	@rm coverage.out
+
+test-coverage: test
+	@$(GO) tool cover -html=coverage.out -o coverage.html
+	@echo "coverage report written to coverage.html"
 
 
 .PHONY: generate