Gator/.github/workflows/python-package.yml at main · Intuity/Gator · 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
name: Python package

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

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment to GitHub pages, but don't cancel running
# builds and wait for completion
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  lint:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: 3.11
    - name: Install Poetry
      run: |
        python -m pip install --upgrade pip
        python -m pip install poetry poethepoet
    - name: Setup environment
      run: |
        poetry install --with dev
    - name: Run lint
      run: |
        poe lint

  build_docs:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: 3.11
    - name: Install Poetry
      run: |
        python -m pip install --upgrade pip
        python -m pip install poetry poethepoet
    - name: Setup environment
      run: |
        poetry install --with dev
    - name: Build documentation
      run: |
        poe docs
    - name: Upload documentation artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: ./site

  deploy_docs:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    needs: build_docs
    steps:
      - name: Deploy to GitHub pages
        id: deployment
        uses: actions/deploy-pages@v4

  unit_tests:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.11", "3.12", "3.13"]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install Poetry
      run: |
        python -m pip install --upgrade pip
        python -m pip install poetry poethepoet
    - name: Setup environment
      run: |
        poetry install --with dev
    - name: Run tests
      timeout-minutes: 5
      run: |
        poe test
    - name: Run Examples
      timeout-minutes: 5
      run: |
        poe example
    - name: Archive code coverage results
      uses: actions/upload-artifact@v4
      with:
        name: pytest-cov-${{ matrix.python-version }}
        path: htmlcov