From 9851f2a6aec98953b1fac48a8ad4d96f04ba20a4 Mon Sep 17 00:00:00 2001 From: enihsago Date: Sun, 8 Mar 2026 03:56:07 +0800 Subject: [PATCH] docs: add explanatory comments to coverage workflow (#610) Add comprehensive documentation at the top of the coverage workflow file to help developers understand: - What the coverage workflow does - How to view coverage reports (Codecov links) - What coverage files are generated - Configuration options and requirements This improves developer experience by making the CI/CD pipeline more transparent and easier to understand for contributors. Co-authored-by: enihsago --- .github/workflows/coverage.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 8489d69d..e7371677 100644 --- a/.github/workflows/coverage.yml +++ b/.github/workflows/coverage.yml @@ -1,3 +1,31 @@ +# Code Coverage Workflow +# +# This workflow runs test coverage analysis and uploads reports to Codecov. +# Coverage reports help identify untested code paths and maintain code quality. +# +# What it does: +# - Runs unit and integration tests with coverage instrumentation +# - Runs E2E tests with coverage instrumentation +# - Uploads coverage reports to Codecov (https://codecov.io/gh/nearai/ironclaw) +# +# Viewing coverage reports: +# - PRs automatically get coverage comments showing changes in coverage +# - Visit https://codecov.io/gh/nearai/ironclaw for detailed coverage reports +# - Coverage reports are generated for three configurations: +# 1. all-features: Full feature set +# 2. default: Default features +# 3. libsql-only: Minimal libSQL-only configuration +# - E2E coverage tracks end-to-end test coverage separately +# +# Coverage files: +# - Unit/integration: lcov.info (uploaded to Codecov with "unit" flag) +# - E2E: e2e-coverage.info (uploaded to Codecov with "e2e" flag) +# +# Requirements: +# - Uses cargo-llvm-cov for coverage instrumentation +# - Requires PostgreSQL for integration tests (pgvector/pgvector:pg16) +# - E2E tests require Python 3.12 and Playwright + name: Code Coverage on: push: