firebase-functions-python/.github/workflows/ci.yaml at main · firebase/firebase-functions-python · 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
name: ci

on:
  pull_request:
  push:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python: ["3.10", "3.12"]

    steps:
      - uses: actions/checkout@v3
      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          enable-cache: true
      - name: Set up Python ${{ matrix.python }}
        run: uv python install ${{ matrix.python }}
      - name: Install dependencies
        run: |
          uv sync --python ${{ matrix.python }}
      - name: Test with pytest & coverage
        run: |
          uv run --python ${{ matrix.python }} pytest --cov=src --cov-report term --cov-report html --cov-report xml -vv
      # TODO requires activation for this repository on codecov website first.
      # - name: Upload coverage to Codecov
      #   uses: codecov/codecov-action@v3

  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          enable-cache: true
      - name: Set up Python
        run: uv python install 3.10
      - name: Install dependencies
        run: |
          uv sync
      - name: Lint with ruff
        run: |
          uv run ruff check .
      - name: Lint with mypy
        run: |
          uv run mypy .

  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          enable-cache: true
      - name: Set up Python
        run: uv python install 3.10
      - name: Install dependencies
        run: |
          uv sync
      - name: Generate Reference Docs
        run: |
          mkdir ./docs/build
          uv run ./docs/generate.sh --out=./docs/build/ --pypath=src/
      - uses: actions/upload-artifact@v4
        name: Upload Docs Preview
        with:
          name: reference-docs
          path: ./docs/build/

  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install uv
        uses: astral-sh/setup-uv@v3
        with:
          enable-cache: true
      - name: Set up Python
        run: uv python install 3.10
      - name: Install dependencies
        run: |
          uv sync
      - name: Check Formatting with ruff
        run: |
          uv run ruff format --check .