chore: add test coverage and coverage report to the README

.github/workflows/coverage_report.yml

@@ -0,0 +1,55 @@
+name: Coverage Report
+
+on:
+  workflow_run:
+    workflows: ["Test lint and build"]
+    branches: [main]
+    types:
+      - completed
+
+jobs:
+
+  workflow:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+          persist-credentials: false 
+          fetch-depth: 0 
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.22'
+
+    - uses: extractions/setup-just@v1
+
+    - name: Test
+      run: |
+        just test-ci
+        go tool cover -func=coverage.out -o=coverage.out
+
+    - name: Go Coverage Badge
+      uses: tj-actions/coverage-badge-go@v2
+      with:
+        filename: coverage.out
+
+    - name: Verify Changed files
+      uses: tj-actions/verify-changed-files@v16
+      id: verify-changed-files
+      with:
+        files: README.md
+
+    - name: Commit changes
+      run: |
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add README.md
+        git commit -m "chore: Updated coverage badge."
+
+    - name: Push changes
+      if: steps.verify-changed-files.outputs.files_changed == 'true'
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ github.token }}
+        branch: ${{ github.head_ref }}

.github/workflows/go.yml → .github/workflows/test_lint_and_build.yml

@@ -1,7 +1,4 @@
-# This workflow will build a golang project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
-
-name: Go
+name: Test lint and build
 
 on:
   push:
@@ -10,7 +7,6 @@ on:
     branches: [ "main" ]
 
 jobs:
-
   workflow:
     runs-on: ubuntu-latest
     steps:
@@ -24,14 +20,14 @@ jobs:
 
     - uses: extractions/setup-just@v1
 
-    - name: Test
-      run: just test
-
     - name: Lint
       uses: golangci/golangci-lint-action@v3
       with:
         version: v1.57.2
         args: --out-format=colored-line-number -v ./...
 
+    - name: Test
+      run: just test-ci
+
     - name: Build
       run: go build -v ./...

.gitignore

@@ -1 +1,3 @@
+coverage.out
+
 playground/

justfile

@@ -14,6 +14,10 @@ test:
 test-all:
 	go test -tags=integration ./...
 
+# run test generating coverage
+test-ci:
+	go test -v ./... -covermode=count -coverprofile=coverage.out 
+
 # lint the code
 lint:
 	golangci-lint run -v ./...