Skip to content

README.md

Latest commit

 

History

History
73 lines (57 loc) · 2.79 KB

README.md

File metadata and controls

73 lines (57 loc) · 2.79 KB
Raw

Upload Coverage

Frozen legacy reference. For new integrations and contributions, use the maintained upload-coverage guide and contribution guide. The examples below describe legacy consumers, not a new-setup recommendation. Keep existing calls pinned to a reviewed full commit SHA; do not copy floating refs or change a consumer's automation without reviewing its migration.

Upload a Cobertura XML coverage report to GitHub Code Quality so the aggregate coverage percentage appears on pull requests.

GitHub Code Quality requires the org/repo to be on a Team or Enterprise Cloud plan, and Code Quality must be enabled in the repository's Settings → Code quality. Fork PRs and merge-queue runs are skipped automatically by the underlying actions/upload-code-coverage action.

Inputs

Name Description Required Default
file Path to the Cobertura XML coverage report to upload ✅ -
language Linguist language name for the report (e.g. Go, C#) ✅ -
label Label for the coverage report (e.g. code-coverage/go) ❌ code-coverage
fail-on-error Fail the step if the GitHub upload fails (errors are always surfaced as annotations) ❌ false
token GitHub token with code-quality: write (the calling job must grant the permission) ❌ ${{ github.token }}

Outputs

This action has no outputs.

Permissions

The calling job must grant code-quality: write — a composite action cannot declare it. For push-triggered workflows that resolve PR numbers, also add pull-requests: read.

permissions:
  contents: read
  code-quality: write

Usage

Go (Cobertura produced via gocover-cobertura)

permissions:
  contents: read
  code-quality: write
steps:
  - name: 📄 Generate coverage
    run: |
      go test -race -coverprofile=coverage.txt -covermode=atomic ./...
      go run github.com/boumenot/gocover-cobertura@latest < coverage.txt > coverage.cobertura.xml

  - name: 📊 Upload coverage
    uses: devantler-tech/actions/upload-coverage@main
    with:
      file: coverage.cobertura.xml
      language: Go
      label: code-coverage/go

.NET (Cobertura produced by dotnet test --collect:"XPlat Code Coverage")

permissions:
  contents: read
  code-quality: write
steps:
  - name: 📊 Upload coverage
    uses: devantler-tech/actions/upload-coverage@main
    with:
      file: ./TestResults/coverage.cobertura.xml
      language: C#
      label: code-coverage/dotnet