django-structlog/.github/workflows/main.yml at main · jrobichaud/django-structlog · 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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
name: ci
on:
  push:
    branches:
      - main
      - release/**
    tags:
      - '[0-9]+.[0-9]+.[0-9]+'
      - '[0-9]+.[0-9]+.[0-9]+.dev[0-9]+'
  pull_request: {}

jobs:
  test-demo-app:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
      - name: Install dependencies
        run: |
          pip install --upgrade pip
          pip install -r requirements.txt
      - name: Start Redis
        uses: supercharge/redis-github-action@v2
      - name: Test demo app
        env:
          CELERY_BROKER_URL: redis://0.0.0.0:6379
          DJANGO_SETTINGS_MODULE: config.settings.test_demo_app
        run: pytest --cov=./django_structlog_demo_project --cov-append django_structlog_demo_project
      - uses: codecov/codecov-action@v6
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false # disable for the moment because it prevents PR to succeed
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.10'
          - '3.11'
          - '3.12'
          - '3.13'
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -U setuptools
          python -m pip install tox tox-gh-actions -r requirements/coverage.txt
      - name: Start Redis
        uses: supercharge/redis-github-action@v2
      - name: Test with tox
        run: tox
      - uses: codecov/codecov-action@v6
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false # disable for the moment because it prevents PR to succeed

  test-docs:
    needs:
      - test-demo-app
      - test
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt
      - name: make html
        working-directory: docs
        run: make html
      - name: make doctest
        working-directory: docs
        run: make doctest

  black:
    needs:
      - test-demo-app
      - test
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements/black.txt
      - name: run black
        run: black --check --verbose .

  ruff:
    needs:
      - test-demo-app
      - test
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements/ruff.txt
      - name: run ruff
        run: ruff check .

  mypy:
    needs:
      - test-demo-app
      - test
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements/local.txt -r requirements/mypy.txt
      - name: run mypy
        run: mypy

  isort:
    needs:
      - test-demo-app
      - test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: isort/isort-action@v1
        with:
            requirements-files: "requirements/local-base.txt requirements/isort.txt"

  test-install-base:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -U setuptools
          python -m pip install .
      - name: Import django_structlog modules
        run: |
          python -c "import django_structlog"
          python -c "import django_structlog.apps"
          python -c "import django_structlog.signals"
          python -c "import django_structlog.app_settings"
          python -c "import django_structlog.middlewares.request"

  test-install-celery:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -U setuptools
          python -m pip install .[celery]
      - name: Import django_structlog modules
        run: |
          python -c "import django_structlog"
          python -c "import django_structlog.apps"
          python -c "import django_structlog.signals"
          python -c "import django_structlog.app_settings"
          python -c "import django_structlog.middlewares.request"
      - name: Import django_structlog celery modules
        run: |
          python -c "import django_structlog.celery.receivers"
          python -c "import django_structlog.celery.steps"
          python -c "import django_structlog.celery.signals"

  test-install-commands:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - '3.14'
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -U setuptools
          python -m pip install .[commands]
      - name: Import django_structlog modules
        run: |
          python -c "import django_structlog"
          python -c "import django_structlog.apps"
          python -c "import django_structlog.signals"
          python -c "import django_structlog.app_settings"
          python -c "import django_structlog.middlewares.request"
      - name: Import django_structlog commands modules
        run: |
          python -c "import django_structlog.commands"

  pypi-deployment:
    needs:
      - test-docs
      - test-install-base
      - test-install-celery
      - test-install-commands
      - black
      - ruff
      - mypy
      - isort
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/django-structlog
    permissions:
      id-token: write
    steps:
      - uses: actions/checkout@v6
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -U -q build
      - name: build sdist
        run: python -m build --sdist
      - name: build wheel
        run: python -m build --wheel
      - name: Publish package
        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
        uses: pypa/gh-action-pypi-publish@release/v1