CI: Upload coverprofile to coveralls

Upload the coverprofile results to coveralls.
Add badges for ci to README.md.
Add clean and coverprofile commands to make.
Rename build commands for images to image.

Signed-off-by: Heathcliff <[email protected]>

.github/workflows/ci.yaml

@@ -39,6 +39,8 @@ jobs:
 
   unit-tests:
     uses: heathcliff26/ci/.github/workflows/golang-unit-tests.yaml@main
+    with:
+      coveralls: ${{ github.event_name == 'pull_request' || github.event_name == 'merge_group' }}
 
   validate:
     uses: heathcliff26/ci/.github/workflows/golang-build.yaml@main

.github/workflows/go-testcover-report.yaml

@@ -5,11 +5,10 @@ on:
   workflow_dispatch:
   push:
     branches: ["main"]
-    paths:
-      - "*.go"
-      - "**/*.go"
 
 jobs:
   generate-reports:
     uses: heathcliff26/ci/.github/workflows/golang-testcover-report.yaml@main
     secrets: inherit
+    with:
+      coveralls: true

.gitignore

@@ -6,3 +6,4 @@ test-config.yaml
 
 # Generated go-test coverage reports
 coverprofiles/
+coverprofile.out

Makefile

@@ -5,19 +5,20 @@ CONTAINER_NAME ?= speedtest-exporter
 SLIM_TAG ?= slim
 CLI_TAG ?= cli
 
-default: build
-
 build:
 	hack/build.sh
 
-build-slim:
+image-slim:
 	podman build -t $(REPOSITORY)/$(CONTAINER_NAME):$(SLIM_TAG) .
 
-build-cli:
+image-cli:
 	podman build -f Dockerfile.cli -t $(REPOSITORY)/$(CONTAINER_NAME):$(CLI_TAG) .
 
 test:
-	go test -v ./...
+	go test -v -coverprofile=coverprofile.out ./...
+
+coverprofile:
+	hack/coverprofile.sh
 
 lint:
 	golangci-lint run -v
@@ -31,14 +32,19 @@ validate:
 update-deps:
 	hack/update-deps.sh
 
+clean:
+	rm -rf bin coverprofiles coverprofile.out
+
 .PHONY: \
 	default \
 	build \
-	build-slim \
-	build-cli \
+	image-slim \
+	image-cli \
 	test \
+	coverprofile \
 	lint \
 	fmt \
 	validate \
 	update-deps \
+	clean \
 	$(NULL)

README.md

@@ -1,3 +1,9 @@
+[![CI](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/ci.yaml/badge.svg?event=push)](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/ci.yaml)
+[![Coverage Status](https://coveralls.io/repos/github/heathcliff26/speedtest-exporter/badge.svg)](https://coveralls.io/github/heathcliff26/speedtest-exporter)
+[![Editorconfig Check](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/editorconfig-check.yaml/badge.svg?event=push)](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/editorconfig-check.yaml)
+[![Generate go test cover report](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/go-testcover-report.yaml/badge.svg)](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/go-testcover-report.yaml)
+[![Renovate](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/renovate.yaml/badge.svg)](https://github.com/heathcliff26/speedtest-exporter/actions/workflows/renovate.yaml)
+
 # speedtest-exporter
 
 This project is a prometheus exporter for speedtests implemented in go.

hack/coverprofile.sh

@@ -2,18 +2,18 @@
 
 set -e
 
-script_dir="$(dirname "${BASH_SOURCE[0]}" | xargs realpath)/.."
+base_dir="$(dirname "${BASH_SOURCE[0]}" | xargs realpath)/.."
 
-pushd "${script_dir}" >/dev/null
+pushd "${base_dir}" >/dev/null
 
-OUT_DIR="${script_dir}/coverprofiles"
+OUT_DIR="${base_dir}/coverprofiles"
 APP="speedtest-exporter"
 
 if [ ! -d "${OUT_DIR}" ]; then
     mkdir "${OUT_DIR}"
 fi
 
-go test -coverprofile="${OUT_DIR}/cover-${APP}.out" "./..."
-go tool cover -html "${OUT_DIR}/cover-${APP}.out" -o "${OUT_DIR}/index.html"
+make test
+go tool cover -html "coverprofile.out" -o "${OUT_DIR}/index.html"
 
 popd >/dev/null