Skip to content

👥 Update Pydantic People (#9326) #651

👥 Update Pydantic People (#9326)

👥 Update Pydantic People (#9326) #651

Workflow file for this run

name: Publish Documentation
on:
push:
branches:
- main
- docs-update
tags:
- '**'
env:
COLUMNS: 150
PDM_DEPS: 'urllib3<2'
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pdm-project/setup-pdm@v4
with:
python-version: '3.11'
cache: true
- name: install
run: pdm install -G linting -G email
- uses: pre-commit/action@v3.0.1
with:
extra_args: --all-files --verbose
env:
SKIP: no-commit-to-branch
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pdm-project/setup-pdm@v4
with:
python-version: '3.11'
cache: true
- name: install deps
run: pdm install -G testing -G email
- run: pdm info && pdm list
- run: 'pdm run python -c "import pydantic.version; print(pydantic.version.version_info())"'
- run: make test
publish:
# Compare with the docs-build job in .github/workflows/ci.yml
needs: [lint, test]
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- name: checkout docs-site
uses: actions/checkout@v4
with:
ref: docs-site
- name: checkout current branch
uses: actions/checkout@v4
- uses: pdm-project/setup-pdm@v4
with:
python-version: '3.10'
- name: install
run: |
pdm venv create --with-pip --force $PYTHON
pdm install -G docs
pdm run python -m pip install https://files.scolvin.com/${MKDOCS_TOKEN}/mkdocs_material-9.5.17+insiders.4.53.5-py3-none-any.whl
env:
MKDOCS_TOKEN: ${{ secrets.MKDOCS_TOKEN }}
- run: pdm run python -c 'import docs.plugins.main'
# Adding local symlinks gets nice source locations like
# pydantic_core/core_schema.py
# instead of
# .venv/lib/python3.10/site-packages/pydantic_core/core_schema.py
- name: prepare shortcuts for extra modules
run: |
ln -s .venv/lib/python*/site-packages/pydantic_core pydantic_core
ln -s .venv/lib/python*/site-packages/pydantic_settings pydantic_settings
ln -s .venv/lib/python*/site-packages/pydantic_extra_types pydantic_extra_types
- name: Set git credentials
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
- run: pdm run mike deploy -b docs-site dev --push
if: "github.ref == 'refs/heads/main'"
- if: "github.ref == 'refs/heads/docs-update' || startsWith(github.ref, 'refs/tags/')"
id: check-version
uses: samuelcolvin/check-python-version@v4.1
with:
version_file_path: 'pydantic/version.py'
skip_env_check: true
- run: pdm run mike deploy -b docs-site ${{ steps.check-version.outputs.VERSION_MAJOR_MINOR }} latest --update-aliases --push
if: "(github.ref == 'refs/heads/docs-update' || startsWith(github.ref, 'refs/tags/')) && !fromJSON(steps.check-version.outputs.IS_PRERELEASE)"
env:
PYDANTIC_VERSION: v${{ steps.check-version.outputs.VERSION }}