Merge pull request #76 from nanotaboada/ci/42-coverage-codecov-reporting

ci(workflow): add coverage reporting with Codecov (#42)

Author: nanotaboada

.github/workflows/rust-ci.yml

@@ -10,10 +10,8 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  commitlint:
-    name: Commitlint
+  lint:
     runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request'
     permissions:
       contents: read
       pull-requests: read
@@ -23,38 +21,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Run commitlint
+      - name: Lint commit messages
         uses: wagoid/commitlint-github-action@v6.2.1
 
-  format:
-    name: Format
-    runs-on: ubuntu-latest
-    needs: commitlint
-    if: always() && (needs.commitlint.result == 'success' || needs.commitlint.result == 'skipped')
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6.0.2
-
       - name: Set up Rust
         uses: dtolnay/rust-toolchain@stable
         with:
-          components: rustfmt
-
-      - name: Check formatting
-        run: cargo fmt --all -- --check
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    needs: format
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v6.0.2
-
-      - name: Set up Rust
-        uses: dtolnay/rust-toolchain@stable
-        with:
-          components: clippy
+          components: rustfmt, clippy
 
       - name: Cache dependencies
         uses: actions/cache@v5.0.4
@@ -63,15 +36,19 @@ jobs:
             ~/.cargo/registry
             ~/.cargo/git
             target
-          key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-lint-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Check formatting
+        run: cargo fmt --all -- --check
 
       - name: Run Clippy
         run: cargo clippy --all-targets --all-features -- -D warnings
 
   build:
-    name: Build
-    runs-on: ubuntu-latest
     needs: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6.0.2
@@ -92,9 +69,10 @@ jobs:
         run: cargo build --verbose
 
   test:
-    name: Test
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6.0.2
@@ -113,3 +91,36 @@ jobs:
 
       - name: Run tests
         run: cargo test --verbose
+
+  coverage:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6.0.2
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache dependencies
+        uses: actions/cache@v5.0.4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-tarpaulin-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Install cargo-tarpaulin
+        run: cargo install cargo-tarpaulin --version 0.35.2 --locked
+
+      - name: Generate coverage report
+        run: cargo tarpaulin --out xml
+
+      - name: Upload coverage report to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: nanotaboada/rust-samples-rocket-restful

CHANGELOG.md

@@ -9,8 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Coverage reporting with `cargo-tarpaulin` and Codecov integration (#42)
+- `codecov.yml` with 80% minimum threshold on `src/services/`, `src/routes/`, `src/repositories/` (#42)
+- Codecov badge in `README.md` (#42)
+
 ### Changed
 
+- Consolidated `commitlint`, `format`, and `lint` CI jobs into a single `lint` job (#42)
+
 ### Fixed
 
 ### Removed

README.md

@@ -2,6 +2,7 @@
 
 [![Rust CI](https://github.com/nanotaboada/rust-samples-rocket-restful/actions/workflows/rust-ci.yml/badge.svg)](https://github.com/nanotaboada/rust-samples-rocket-restful/actions/workflows/rust-ci.yml)
 [![Rust CD](https://github.com/nanotaboada/rust-samples-rocket-restful/actions/workflows/rust-cd.yml/badge.svg)](https://github.com/nanotaboada/rust-samples-rocket-restful/actions/workflows/rust-cd.yml)
+[![codecov](https://codecov.io/gh/nanotaboada/rust-samples-rocket-restful/branch/master/graph/badge.svg)](https://codecov.io/gh/nanotaboada/rust-samples-rocket-restful)
 [![License: MIT](https://img.shields.io/badge/License-MIT-3DA639.svg)](https://opensource.org/licenses/MIT)
 ![Dependabot](https://img.shields.io/badge/Dependabot-contributing-025E8C?logo=dependabot&logoColor=white&labelColor=181818)
 ![Copilot](https://img.shields.io/badge/Copilot-contributing-8662C5?logo=githubcopilot&logoColor=white&labelColor=181818)

codecov.yml

@@ -0,0 +1,30 @@
+# Codecov Configuration
+# Goal: 80% minimum coverage on services/, routes/, repositories/ only
+
+coverage:
+  status:
+    project:
+      default:
+        target: 80%
+        paths:
+          - "src/services/"
+          - "src/routes/"
+          - "src/repositories/"
+
+    patch:
+      default:
+        target: 80%
+
+ignore:
+  - ".github/**/*"
+  - ".vscode/**/*"
+  - "migrations/**/*"
+  - "tests/**/*"
+  - "src/models/**/*"
+  - "src/schema.rs"
+  - "src/state/**/*"
+  - "src/main.rs"
+  - "**/*.toml"
+  - "**/*.yml"
+  - "**/*.yaml"
+  - "**/*.md"