remotebmi/.github/workflows/python.yml at main · eWaterCycle/remotebmi · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
name: Python 🐍

on:
  push:
    branches: [main]
    paths:
      - "openapi.yaml"
      - "python/remotebmi/**"
      - "python/tests/**"
      - "python/pyproject.toml"
      - .github/workflows/python.yml
  pull_request:
    paths:
      - "openapi.yaml"
      - "python/remotebmi/**"
      - "python/tests/**"
      - "python/pyproject.toml"
      - .github/workflows/python.yml
    types: [opened, synchronize, reopened]
  workflow_call:

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

permissions:
  id-token: write # This is required for codecov

defaults:
  run:
    working-directory: python

jobs:
  lint-format:
    name: formatting and type checking 🔍️
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
      - name: Install ruff
        run: pip install ruff
      - name: Run ruff check
        run: ruff check
      - name: Run ruff format
        run: ruff format --check
  typing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
      - name: Install remotebmi
        run: pip install .[dev]  # dev too so tests can be type checked
      - name: Install mypy
        run: pip install mypy numpy
      - name: Run mypy
        run: mypy .
  test:
    name: run test suite 🐛
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: true
      matrix:
        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
        python-version: ['3.10', '3.13']
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: "pip"
      - name: Install dependencies
        run: pip install -e .[dev]
      - name: Run tests
        run: pytest
  cov:
    name: compute and upload coverage
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
      - name: Install dependencies
        run: pip install -e .[dev]
      - name: Run tests
        run: pytest --cov --cov-report=xml
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          file: coverage.xml
          use_oidc: true
  build:
    name: build the package 🛠️
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
      - name: Install build
        run: pip install build
      - name: Build package
        run: python3 -m build
  docs:
    name: test build docs 📖
    runs-on: ubuntu-latest
    env:
      BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
    permissions:
      contents: write
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
      - name: Install docs requirements
        run: pip install -r docs/requirements.txt
      - name: Build docs
        run: make -C docs/ html