martyrology-api/.github/workflows/ci.yml at main · CatholicOS/martyrology-api · 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
name: CI

on:
  push:
    branches: [main]
  pull_request:

jobs:
  lint-typecheck-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 2
          persist-credentials: false

      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.12"

      - name: Install dependencies
        run: pip install -e '.[dev]'

      - name: ruff check
        run: ruff check src tests scripts

      - name: ruff format --check
        run: ruff format --check src tests scripts

      - name: pyright
        run: pyright

      - name: pytest
        id: pytest
        run: pytest -q --cov --cov-branch --cov-report=term-missing --cov-report=xml --junitxml=junit.xml

      - name: Coverage summary
        if: always()
        run: |
          echo '## Coverage' >> "$GITHUB_STEP_SUMMARY"
          coverage report --format=markdown >> "$GITHUB_STEP_SUMMARY" || true

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: CatholicOS/martyrology-api
          files: coverage.xml

      # Upload results when pytest RAN, pass or fail — a failing suite is
      # exactly when Codecov's test analytics earns its keep. Skip when pytest
      # never ran (an earlier step failed), since there is no junit.xml to find
      # and the resulting "unable to find any JUnit XML files" notice reads like
      # a config fault while distracting from the real failure.
      - name: Upload test results to Codecov
        if: ${{ !cancelled() && steps.pytest.conclusion != 'skipped' }}
        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: CatholicOS/martyrology-api
          report_type: test_results
          files: junit.xml

  shellcheck:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: shellcheck
        run: shellcheck scripts/*.sh scripts/deploy/*.sh