Skip to content

test-coverage.md

Latest commit

 

History

History
52 lines (40 loc) · 1.69 KB

test-coverage.md

File metadata and controls

52 lines (40 loc) · 1.69 KB
description Guidance for creating agentic workflows that analyze test coverage — prefer reading pre-computed CI artifacts over re-running tests.

Test Coverage Workflow Guidance

Consult this file when creating or updating a workflow that analyzes test coverage.

Core Principle: Read Artifacts First

Always prefer fetching pre-computed coverage artifacts from CI over re-running the test suite. Re-running tests is slow and duplicates work CI has already done.

Coverage Data Strategy

Include this decision block in every coverage workflow prompt:

1. Find the latest successful CI run for this commit:
   `gh run list --commit "$HEAD_SHA" --status success --limit 5 --json databaseId,workflowName`
2. Download the coverage artifact (try names: coverage-report, coverage, test-results):
   `gh run download <run-id> --name coverage-report --dir /tmp/coverage`
3. If found, parse and analyze it — do NOT re-run tests.
4. If not found, run tests with coverage and note in the report that data was computed fresh.

Frontmatter Template

engine: copilot
on:
  pull_request:
    types: [opened, synchronize]
permissions:
  actions: read         # download artifacts
network: defaults
tools:
  github:
    toolsets: [default, actions]  # actions toolset enables artifact download
safe-outputs:
  add-comment:
    hide-older-comments: true

Fallback: Run Tests

Use only when no prior CI artifact exists or CI doesn't upload coverage. Supported commands:

Language Command
Node.js npx jest --coverage --coverageReporters=json-summary
Python python -m pytest --cov=src --cov-report=json
Go go test ./... -coverprofile=/tmp/coverage.out