zig-test-framework/.github/workflows/ci.yml at main · zig-utils/zig-test-framework · GitHub

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
name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

jobs:
  test:
    name: Test on ${{ matrix.os }} with Zig ${{ matrix.zig-version }}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest]
        zig-version: ['latest']
      fail-fast: false

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Zig
        uses: home-lang/pantry-setup@v1
        with:
          packages: ziglang.org@${{ matrix.zig-version }}

      - name: Verify Zig installation
        run: zig version

      - name: Build framework
        run: zig build

      - name: Run tests
        run: zig build test

      - name: Run examples
        run: zig build examples

  lint:
    name: Lint and Format Check
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Zig
        uses: home-lang/pantry-setup@v1
        with:
          packages: ziglang.org@latest

      - name: Check formatting
        run: zig fmt --check .

  build-docs:
    name: Build Documentation
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Zig
        uses: home-lang/pantry-setup@v1
        with:
          packages: ziglang.org@latest

      - name: Generate docs
        run: zig build-lib -femit-docs src/lib.zig

      - name: Upload docs artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: docs/

  coverage:
    name: Code Coverage
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup Zig
        uses: home-lang/pantry-setup@v1
        with:
          packages: ziglang.org@latest

      - name: Install kcov
        continue-on-error: true
        id: install-kcov
        run: |
          sudo apt-get update
          sudo apt-get install -y kcov

      - name: Build framework
        if: steps.install-kcov.outcome == 'success'
        run: zig build

      - name: Run tests with coverage
        if: steps.install-kcov.outcome == 'success'
        run: ./zig-out/bin/zig-test --test-dir tests --coverage

      - name: Upload coverage to Codecov
        if: steps.install-kcov.outcome == 'success'
        uses: codecov/codecov-action@v4
        with:
          directory: ./coverage
          fail_ci_if_error: false
          verbose: true

      - name: Upload coverage artifact
        if: steps.install-kcov.outcome == 'success'
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: coverage/

      - name: Coverage skipped
        if: steps.install-kcov.outcome != 'success'
        run: echo "kcov not available on this platform, skipping coverage"