File: github.md

package info (click to toggle)
kcov 43%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,600 kB
  • sloc: cpp: 12,617; ansic: 2,379; python: 2,001; sh: 333; makefile: 133; javascript: 65; xml: 7; asm: 4
file content (68 lines) | stat: -rw-r--r-- 1,343 bytes parent folder | download | duplicates (3)
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
# GitHub actions

## Example usage

### `bash-script.sh`

```sh
#!/usr/bin/env bash

if [[ true ]]; then
  echo "Hello, kcov!"
fi
```

### `tests.sh`

```sh
#!/bin/sh

testEquality() {
  assertEquals 1 1
}

. shunit2
```

### `.github/workflows/tests.yml`

```yml
name: Run tests

permissions:
  contents: read

on: [push]

jobs:
  tests:
    name: Run tests
    runs-on: ubuntu-latest
    steps:
        - uses: actions/checkout@v4

        - name: Example with a bash script (running on Docker kcov/kcov)
          uses: sudo-bot/action-kcov@latest
          with:
            cli-args: "--version"

        - name: Run a bash script with kcov coverage
          # Debian based, uses the Docker image kcov/kcov
          uses: sudo-bot/action-kcov@latest
          with:
            cli-args: "--dump-summary ./coverage ./bash-script.sh"

        - name: Run shunit2 tests with kcov coverage
          # Alpine based
          uses: sudo-bot/action-shunit2@latest
          with:
              cli: "kcov --dump-summary ./coverage ./tests.sh"

        - name: Upload coverage reports to Codecov
          uses: codecov/codecov-action@v4
          with:
            # Must be set in the repo or org settings as a secret
            token: ${{ secrets.CODECOV_TOKEN }}
            directory: ./coverage/
            fail_ci_if_error: true
```