Merge pull request #678 from meilisearch/codecov

Add Code Coverage GH action

Author: Mubelotix

.github/workflows/tests.yml

@@ -83,3 +83,36 @@ jobs:
         uses: ibiqlik/action-yamllint@v3
         with:
           config_file: .yamllint.yml
+
+  coverage:
+    # Will not run if the actor is Dependabot (dependabot PRs)
+    # Will not run if the event is a PR to bump-meilisearch-v* (so a pre-release PR)
+    if: github.actor != 'dependabot[bot]' && !( github.event_name == 'pull_request' && startsWith(github.base_ref, 'bump-meilisearch-v') )
+    runs-on: ubuntu-latest
+    needs: integration_tests
+    name: Code Coverage
+    steps:
+      - uses: actions/checkout@v4
+      # Nightly Rust is used for cargo llvm-cov --doc below.
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: llvm-tools-preview
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-llvm-cov
+      - name: Meilisearch (latest version) setup with Docker
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key=masterKey
+      - name: Collect coverage data
+        # Generate separate reports for tests and doctests, and combine them.
+        run: |
+          set -euo pipefail
+          cargo llvm-cov --no-report --all-features --workspace
+          cargo llvm-cov --no-report --doc --all-features --workspace
+          cargo llvm-cov report --doctests --codecov --output-path codecov.json
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: codecov.json
+          fail_ci_if_error: true

README.md

@@ -24,6 +24,7 @@
   <a href="https://github.com/meilisearch/meilisearch-rust/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
   <a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
   <a href="https://ms-bors.herokuapp.com/repositories/62"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://codecov.io/gh/meilisearch/meilisearch-rust" ><img src="https://codecov.io/gh/meilisearch/meilisearch-rust/graph/badge.svg?token=NVO9OI8JMG"/></a>
 </p>
 
 <p align="center">⚡ The Meilisearch API client written for Rust 🦀</p>