python-project-template/.github/workflows/ci.yml at main · YongboYu/python-project-template · 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
name: CI

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

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

env:
  PYTHON_VERSION: "3.12"

jobs:
  # ---------------------------------------------------------------------------
  # pre-commit — runs ruff (lint+format), mypy, bandit via pre-commit hooks
  # ---------------------------------------------------------------------------
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - run: uv sync --frozen --group dev

      - uses: actions/cache@v5
        with:
          path: ~/.cache/pre-commit
          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
          restore-keys: pre-commit-

      - run: uv run pre-commit run --all-files --show-diff-on-failure

  # ---------------------------------------------------------------------------
  # test — pytest + coverage
  # ---------------------------------------------------------------------------
  test:
    runs-on: ubuntu-latest
    needs: pre-commit
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - run: uv sync --frozen --group dev

      - run: |
          uv run pytest \
            --cov=src \
            --cov-report=xml \
            --cov-report=term-missing

      - uses: codecov/codecov-action@v5
        if: always()
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
          # token: ${{ secrets.CODECOV_TOKEN }}

  # ---------------------------------------------------------------------------
  # build — optional: validate that the package builds cleanly
  # Uncomment when ready to package as a library.
  # ---------------------------------------------------------------------------
  # build:
  #   runs-on: ubuntu-latest
  #   needs: [pre-commit, test]
  #   steps:
  #     - uses: actions/checkout@v6
  #
  #     - uses: actions/setup-python@v6
  #       with:
  #         python-version: ${{ env.PYTHON_VERSION }}
  #
  #     - uses: astral-sh/setup-uv@v7
  #
  #     - run: uv build
  #
  #     - run: uv run twine check dist/*