coverage-badge 0.2.0

Generate shields.io-style SVG badges for test coverage percentages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# coverage-badge

[![CI](https://github.com/ozankasikci/rust-test-coverage-badge/actions/workflows/coverage.yml/badge.svg)](https://github.com/ozankasikci/rust-test-coverage-badge/actions/workflows/coverage.yml)
[![Crates.io](https://img.shields.io/crates/v/coverage-badge.svg)](https://crates.io/crates/coverage-badge)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Coverage](assets/coverage.svg)

A GitHub Action and CLI tool that generates shields.io-style SVG badges for test coverage.

## Table of Contents

- [Quick Start](#quick-start)
- [Full Workflow Example](#full-workflow-example)
- [Action Inputs](#action-inputs)
- [CLI Usage](#cli-usage)
- [Color Thresholds](#color-thresholds)
- [License](#license)

## Quick Start

Add this step to your workflow after running your coverage tool:

```yaml
- name: Generate coverage badge
  uses: ozankasikci/rust-test-coverage-badge@v1
  with:
    coverage: ${{ steps.coverage.outputs.percentage }}
    output: assets/coverage.svg
    commit: true
```

That's it! The action generates the badge and commits it to your repo. Then reference it in your README:

```markdown
![Coverage](assets/coverage.svg)
```

## Full Workflow Example

<details>
<summary>Click to expand complete workflow</summary>

```yaml
name: Coverage

on:
  push:
    branches: [main]

permissions:
  contents: write

jobs:
  coverage:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Replace with your actual coverage tool
      - name: Run tests with coverage
        id: coverage
        run: |
          # Example: extract coverage from your tool's output
          # For tarpaulin: jq '.coverage' tarpaulin-report.json
          # For pytest-cov: grep -oP 'TOTAL.*\s+\K\d+' coverage.txt
          echo "percentage=85.5" >> $GITHUB_OUTPUT

      - name: Generate coverage badge
        uses: ozankasikci/rust-test-coverage-badge@v1
        with:
          coverage: ${{ steps.coverage.outputs.percentage }}
          output: assets/coverage.svg
          commit: true
          commit-message: 'chore: update coverage badge'
```

</details>

## Action Inputs

| Input | Required | Default | Description |
|-------|----------|---------|-------------|
| `coverage` | Yes | - | Coverage percentage (0-100, decimals allowed) |
| `output` | Yes | - | Output path for the SVG file |
| `commit` | No | `false` | Commit and push the badge |
| `commit-message` | No | `Update coverage badge` | Custom commit message |

## CLI Usage

For local development or custom setups, use the CLI directly.

**Install:**

```bash
# Via Cargo
cargo install coverage-badge

# Or download from Releases
# https://github.com/ozankasikci/rust-test-coverage-badge/releases
```

**Run:**

```bash
coverage-badge -c 85 -o assets/coverage.svg
```

| Option | Short | Description |
|--------|-------|-------------|
| `--coverage` | `-c` | Coverage percentage (0-100, decimals allowed) |
| `--output` | `-o` | Output path for the SVG file |

## Color Thresholds

| Coverage | Color |
|----------|-------|
| < 50% | Red |
| 50-79% | Yellow |
| ≥ 80% | Green |

## License

MIT