python_package/.github/workflows/cicd.yml at 1ee5c9601ecf2c0fa44ae07dcbe44eca033e50da · biosustain/python_package · 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
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python application

on:
  push:
  pull_request:
    branches: ["main"]
  schedule:
    - cron: "0 2 * * 3"

permissions:
  contents: read

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: psf/black@stable
      - uses: isort/isort-action@v1
  lint:
    name: Lint with ruff
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Install ruff
        run: |
          pip install ruff
      - name: Lint with ruff
        run: |
          # stop the build if there are Python syntax errors or undefined names
          ruff check src
  test:
    name: Test
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.11", "3.12"]
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: "pip" # caching pip dependencies
          cache-dependency-path: "**/pyproject.toml"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install pytest
          pip install -e .
      - name: Run tests
        run: python -m pytest tests

  build_source_dist:
    name: Build source distribution
    if: startsWith(github.ref, 'refs/heads/main') || startsWith(github.ref, 'refs/tags')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install build
        run: python -m pip install build

      - name: Run build
        run: python -m build --sdist

      - uses: actions/upload-artifact@v4
        with:
          path: ./dist/*.tar.gz
  # Needed in case of building packages with external binaries (e.g. Cython, RUst-extensions, etc.)
  # build_wheels:
  #   name: Build wheels on ${{ matrix.os }}
  #   if: startsWith(github.ref, 'refs/heads/main') || startsWith(github.ref, 'refs/tags')
  #   runs-on: ${{ matrix.os }}
  #   strategy:
  #       matrix:
  #         os: [ubuntu-20.04, windows-2019, macOS-10.15]

  #   steps:
  #       - uses: actions/checkout@v4

  #       - uses: actions/setup-python@v5
  #         with:
  #           python-version: "3.10"

  #       - name: Install cibuildwheel
  #         run: python -m pip install cibuildwheel==2.3.1

  #       - name: Build wheels
  #         run: python -m cibuildwheel --output-dir wheels

  #       - uses: actions/upload-artifact@v4
  #         with:
  #           path: ./wheels/*.whl

  publish:
    name: Publish package
    if: startsWith(github.ref, 'refs/tags')
    permissions:
      id-token: write
    needs:
      - format
      - lint
      - test
      - build_source_dist
      # - build_wheels
    runs-on: ubuntu-latest

    steps:
      - uses: actions/download-artifact@v4
        with:
          name: artifact
          path: ./dist
      # register PyPI integration:
      # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
      - uses: pypa/gh-action-pypi-publish@release/v1
        with:
          # remove repository key to set the default to pypi (not test.pypi.org)
          repository-url: https://test.pypi.org/legacy/