Clarify behavior around field defaults in the docs #148
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Run CI | |
# Run this workflow every time a new commit pushed to your repository | |
on: | |
push: | |
branches: | |
- main | |
tags: | |
- "*" | |
pull_request: | |
workflow_dispatch: | |
jobs: | |
tests: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python: ["3.10", "3.11", "3.12"] | |
django: ["3.2", "4.2"] | |
pydantic: ["2.0", "2.10"] | |
name: Run the test suite (Python ${{ matrix.python }}, Django ${{ matrix.django }}, Pydantic ${{ matrix.pydantic }}) | |
services: | |
postgres: | |
image: postgres | |
env: | |
POSTGRES_HOST_AUTH_METHOD: trust | |
ports: | |
- 5432:5432 | |
# needed because the postgres container does not provide a healthcheck | |
options: >- | |
--health-cmd pg_isready | |
--health-interval 10s | |
--health-timeout 5s | |
--health-retries 5 | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python }} | |
- name: Install dependencies | |
run: pip install tox tox-gh-actions | |
- name: Run tests | |
run: tox | |
env: | |
PYTHON_VERSION: ${{ matrix.python }} | |
DJANGO: ${{ matrix.django }} | |
PYDANTIC: ${{ matrix.pydantic }} | |
- name: Publish coverage report | |
uses: codecov/codecov-action@v3 | |
publish: | |
name: Publish package to PyPI | |
runs-on: ubuntu-latest | |
needs: tests | |
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.10" | |
- name: Build sdist and wheel | |
run: | | |
pip install build --upgrade | |
python -m build | |
# TODO: switch to verified publishers | |
- name: Publish a Python distribution to PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
user: __token__ | |
password: ${{ secrets.PYPI_TOKEN }} |