VitestのカバレッジレポートをGithub Actionsで添付する実装例

1
# ...
2
jobs:
3
    steps:
4
        # ...
5
    - run: npx vitest run --coverage
6
    - uses: davelosert/vitest-coverage-report-action@v2

1
// ...
2
export default defineConfig({
3
  // ...
4
  test: {
5
    // ...
6
    coverage: {
7
      reporter: ["text", "json-summary", "json"],
8
    },
9
  },
10
});

1
# ...
2
jobs:
3
    steps:
4
        # ...
5
    - run: npx vitest run --coverage
6
    - uses: davelosert/vitest-coverage-report-action@v2
7
      if: always()

1
// ...
2
export default defineConfig({
3
  // ...
4
  test: {
5
    // ...
6
    coverage: {
7
      reporter: ["text", "json-summary", "json"],
8
      reportOnFailure: true,
9
    },
10
  },
11
});

1
# ...
2
jobs:
3
    steps:
4
        # ...
5
    - run: npx vitest run --coverage
6
    - uses: davelosert/vitest-coverage-report-action@v2
7
      threshold-icons: "{0: '🔴', 40: '🟠', 70: '🟢'}"

1
import { defineConfig } from "vite";
2

3
export default defineConfig({
4
  // ...
5
  test: {
6
    // ...
7
    coverage: {
8
　   include: ["src/**"],
9
      reporter: ["text", "json-summary", "json"],
10
      reportOnFailure: true,
11
    },
12
  },
13
});

1
on:
2
  push:
3
    branches:
4
      - main
5
  pull_request:
6

7
jobs:
8
    steps:
9
        # ...
10
    - run: npx vitest run --coverage
11
    - uses: actions/upload-artifact@v6
12
      if: github.ref == 'refs/heads/main'
13
      with:
14
        name: coverage-main
15
        path: coverage/
16
        retention-days: 7
17
    - name: Get main run ID
18
      if: github.ref != 'refs/heads/main'
19
      continue-on-error: true
20
      run: |
21
        RUN_ID=$(gh run list --workflow "${{ github.workflow }}" --branch ${{ github.event.repository.default_branch }} --status success --limit 1 --json databaseId --jq '.[0].databaseId')
22
        echo "RUN_ID=$RUN_ID" >> $GITHUB_ENV
23

24
    - name: Download artifact
25
      if: env.IS_DEFAULT_BRANCH == 'false' && env.RUN_ID != ''
26
      uses: actions/download-artifact@v7
27
      continue-on-error: true
28
      with:
29
        name: coverage-main
30
        run-id: ${{ env.RUN_ID }}
31
        github-token: ${{ github.token }}
32
        path: coverage-main
33

34
    - name: Ensure coverage files exist
35
      if: github.ref != 'refs/heads/main'
36
      # デフォルトブランチのカバレッジレポートが取得できない場合、
37
      # 現在のブランチにあるカバレッジレポートで代替する。
38
      run: |
39
        if [ ! -f coverage-main/coverage-summary.json ]; then
40
          echo "Main branch coverage not found, using current coverage for comparison."
41
          mkdir -p coverage-main
42
          cp coverage/coverage-summary.json coverage-main/coverage-summary.json
43
        fi
44

45
    - name: Report Coverage
46
      if: github.ref != 'refs/heads/main'
47
      uses: davelosert/vitest-coverage-report-action@v2
48
      with:
49
        json-summary-compare-path: coverage-main/coverage-summary.json

1
# ...
2
jobs:
3
    steps:
4
        # ...
5
    - uses: davelosert/vitest-coverage-report-action@v2
6
      with:
7
        pr-number: ${{ github.event_name == 'pull_request' && github.event.number || 'auto' }}

1
name: vitest coverage report
2
description: Generate vitest coverage report.
3

4
runs:
5
  using: composite
6
  steps:
7
    - name: Detect default branch
8
      shell: bash
9
      run: |
10
        echo "IS_DEFAULT_BRANCH=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}" >> $GITHUB_ENV
11

12
    - name: Upload coverage to artifacts
13
      if: env.IS_DEFAULT_BRANCH == 'true'
14
      uses: actions/upload-artifact@v6
15
      with:
16
        name: coverage-main
17
        path: coverage/
18
        retention-days: 7
19

20
    - name: Download coverage from main
21
      shell: bash
22
      if: env.IS_DEFAULT_BRANCH == 'false'
23
      env:
24
        GH_TOKEN: ${{ github.token }}
25
      run: |
26
        RUN_ID=$(gh run list --workflow "${{ github.workflow }}" --branch ${{ github.event.repository.default_branch }} --status success --limit 1 --json databaseId --jq '.[0].databaseId')
27
        echo "RUN_ID=$RUN_ID" >> $GITHUB_ENV
28
      continue-on-error: true
29

30
    - name: Download artifact
31
      if: env.IS_DEFAULT_BRANCH == 'false' && env.RUN_ID != ''
32
      uses: actions/download-artifact@v7
33
      with:
34
        name: coverage-main
35
        run-id: ${{ env.RUN_ID }}
36
        github-token: ${{ github.token }}
37
        path: coverage-main
38
      continue-on-error: true
39

40
    - name: Ensure coverage files exist
41
      if: env.IS_DEFAULT_BRANCH == 'false'
42
      shell: bash
43
      continue-on-error: true
44
      run: |
45
        if [ ! -f coverage-main/coverage-summary.json ]; then
46
          echo "Main branch coverage not found, using current coverage for comparison."
47
          mkdir -p coverage-main
48
          cp coverage/coverage-summary.json coverage-main/coverage-summary.json
49
        fi
50
    - name: Report Coverage
51
      if: env.IS_DEFAULT_BRANCH == 'false'
52
      uses: davelosert/vitest-coverage-report-action@v2
53
      with:
54
        json-summary-compare-path: coverage-main/coverage-summary.json
55
        pr-number: ${{ github.event_name == 'pull_request' && github.event.number || 'auto' }}
56
        threshold-icons: "{0: '🔴', 20: '🟠', 60: '🟢'}"