Build docs on OS Ubuntu 22.04 (#1134) #494
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: CI | |
on: | |
push: | |
branches: [main] | |
tags: ["*"] | |
pull_request: | |
branches: [main] | |
workflow_dispatch: | |
env: | |
FORCE_COLOR: "1" # Make tools pretty. | |
TOX_TESTENV_PASSENV: FORCE_COLOR | |
PIP_DISABLE_PIP_VERSION_CHECK: "1" | |
PIP_NO_PYTHON_VERSION_WARNING: "1" | |
# Keep in sync with .pre-commit-config.yaml/default_language_version/python. | |
PYTHON_LATEST: "3.11" | |
# Use oldest version used in doctests / examples. | |
SETUPTOOLS_SCM_PRETEND_VERSION: "19.2.0" | |
permissions: | |
contents: read | |
jobs: | |
tests: | |
name: Tests on ${{ matrix.python-version }} | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: | |
- "3.7" | |
- "3.8" | |
- "3.9" | |
- "3.10" | |
- "3.11" | |
- "~3.12.0-0" | |
- "pypy-3.7" | |
- "pypy-3.8" | |
continue-on-error: >- | |
${{ contains(matrix.python-version, '~') && true || false }} | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- run: python -Im pip install --upgrade wheel tox | |
- name: Determine Python version for tox | |
run: | | |
V=${{ matrix.python-version }} | |
if [[ "$V" = ~* ]]; then | |
# Extract version from a '~3.XX.0-0' specifier. | |
V=${V:1:4} | |
fi | |
if [[ "$V" = pypy-* ]]; then | |
V=pypy3 | |
else | |
V=py$(echo $V | tr -d .) | |
fi | |
echo TOX_PYTHON=$V >>$GITHUB_ENV | |
- run: python -Im tox run -f ${{ env.TOX_PYTHON }} | |
- name: Upload coverage data | |
uses: actions/upload-artifact@v3 | |
with: | |
name: coverage-data | |
path: .coverage.* | |
if-no-files-found: ignore | |
coverage: | |
runs-on: ubuntu-latest | |
needs: tests | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
# Use latest Python, so it understands all syntax. | |
python-version: ${{env.PYTHON_LATEST}} | |
- run: python -Im pip install --upgrade coverage[toml] | |
- name: Download coverage data | |
uses: actions/download-artifact@v3 | |
with: | |
name: coverage-data | |
- name: Combine coverage and fail if it's <100%. | |
run: | | |
python -Im coverage combine | |
python -Im coverage html --skip-covered --skip-empty | |
python -Im coverage report --fail-under=100 | |
- name: Upload HTML report if check failed. | |
uses: actions/upload-artifact@v3 | |
with: | |
name: html-report | |
path: htmlcov | |
if: ${{ failure() }} | |
docs: | |
name: Build docs & run doctests | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
# Keep in sync with tox/docs and .readthedocs.yaml. | |
python-version: "3.11" | |
- run: python -Im pip install --upgrade wheel tox | |
- run: python -Im tox -e docs,changelog | |
mypy: | |
name: Mypy on ${{ matrix.python-version }} | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: | |
- "3.7" | |
- "3.8" | |
- "3.9" | |
- "3.10" | |
- "3.11" | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- run: python -Im pip install --upgrade wheel tox | |
- run: python -Im tox run -e mypy | |
pyright: | |
name: Check types using pyright | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: ${{env.PYTHON_LATEST}} | |
- run: python -Im pip install --upgrade wheel tox | |
- run: python -Im tox run -e pyright | |
install-dev: | |
name: Verify dev env | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest, windows-latest] | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: ${{env.PYTHON_LATEST}} | |
- run: python -Im pip install -e .[dev] | |
- run: python -Ic 'import attr; print(attr.__version__)' | |
- run: python -Ic 'import attrs; print(attrs.__version__)' | |
# Ensure everything required is passing for branch protection. | |
required-checks-pass: | |
if: always() | |
needs: | |
- coverage | |
- docs | |
- install-dev | |
- mypy | |
# Pyright is currently flaky | |
# XXX: https://github.com/ekalinin/nodeenv/issues/324 | |
# - pyright | |
runs-on: ubuntu-latest | |
steps: | |
- name: Decide whether the needed jobs succeeded or failed | |
uses: re-actors/alls-green@release/v1 | |
with: | |
jobs: ${{ toJSON(needs) }} |