Build docs on 3.12 #156
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] | |
| pull_request: | |
| workflow_dispatch: | |
| env: | |
| FORCE_COLOR: "1" # Make tools pretty. | |
| PIP_DISABLE_PIP_VERSION_CHECK: "1" | |
| PIP_NO_PYTHON_VERSION_WARNING: "1" | |
| SETUPTOOLS_SCM_PRETEND_VERSION: "1.0" # avoid warnings about shallow checkout | |
| # For re-actors/checkout-python-sdist | |
| sdist-artifact: python-package-distributions | |
| sdist-name: environ_config-1.0.tar.gz | |
| permissions: | |
| contents: read | |
| jobs: | |
| cog-check: | |
| name: Ensure cogified files are up-to-date | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| cache: pip | |
| python-version: "3.x" | |
| - run: python -Im pip install --upgrade wheel nox | |
| - run: python -Im nox -e cog -- --check | |
| build-sdist: | |
| name: 📦 Build the source distribution | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version-file: .python-version-default | |
| cache: pip | |
| - run: python -Im pip install build | |
| - run: python -Im build --sdist | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: ${{ env.sdist-artifact }} | |
| # NOTE: Exact expected file names are specified here | |
| # NOTE: as a safety measure — if anything weird ends | |
| # NOTE: up being in this dir or not all dists will be | |
| # NOTE: produced, this will fail the workflow. | |
| path: dist/${{ env.sdist-name }} | |
| retention-days: 15 | |
| tests: | |
| name: Tests on ${{ matrix.python-version }} | |
| needs: [build-sdist] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: | |
| # [[[cog | |
| # for line in open("pyproject.toml"): | |
| # if "Programming Language :: Python :: " in line: | |
| # cog.outl(f'- "{line.rsplit(" ")[-1][:-3]}"') | |
| # ]]] | |
| - "3.8" | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| # [[[end]]] | |
| steps: | |
| - name: Get source code from pre-built sdist | |
| uses: re-actors/checkout-python-sdist@release/v1 | |
| with: | |
| source-tarball-name: ${{ env.sdist-name }} | |
| workflow-artifact-name: ${{ env.sdist-artifact }} | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| cache: pip | |
| - run: python -Im pip install --upgrade wheel nox | |
| - run: python -Im nox --python ${{ matrix.python-version }} --tags tests | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: coverage-data | |
| path: .coverage.* | |
| if-no-files-found: ignore | |
| coverage: | |
| name: Combine & check coverage | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - name: Get source code from pre-built sdist | |
| uses: re-actors/checkout-python-sdist@release/v1 | |
| with: | |
| source-tarball-name: ${{ env.sdist-name }} | |
| workflow-artifact-name: ${{ env.sdist-artifact }} | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version-file: .python-version-default | |
| cache: pip | |
| - run: python -Im pip install --upgrade coverage[toml] | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| name: coverage-data | |
| - name: Combine coverage & fail if it's <100%. | |
| run: | | |
| python -Im coverage combine | |
| python -Im coverage html --skip-covered --skip-empty | |
| # Report and write to summary. | |
| python -Im coverage report | sed 's/^/ /' >> $GITHUB_STEP_SUMMARY | |
| # Report again and fail if under 100%. | |
| 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() }} | |
| mypy: | |
| name: Mypy on ${{ matrix.python-version }} | |
| needs: [build-sdist] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| # [[[cog | |
| # for line in open("pyproject.toml"): | |
| # if "Programming Language :: Python :: " in line: | |
| # cog.outl(f'- "{line.rsplit(" ")[-1][:-3]}"') | |
| # ]]] | |
| - "3.8" | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| # [[[end]]] | |
| steps: | |
| - name: Get source code from pre-built sdist | |
| uses: re-actors/checkout-python-sdist@release/v1 | |
| with: | |
| source-tarball-name: ${{ env.sdist-name }} | |
| workflow-artifact-name: ${{ env.sdist-artifact }} | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| cache: pip | |
| - run: python -Im pip install --upgrade wheel nox | |
| - run: python -Im nox -e mypy | |
| docs: | |
| name: Build docs & run doctests | |
| needs: [build-sdist] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get source code from pre-built sdist | |
| uses: re-actors/checkout-python-sdist@release/v1 | |
| with: | |
| source-tarball-name: ${{ env.sdist-name }} | |
| workflow-artifact-name: ${{ env.sdist-artifact }} | |
| - uses: actions/setup-python@v4 | |
| with: | |
| cache: pip | |
| # [[[cog | |
| # import yaml | |
| # with open(".readthedocs.yaml") as f: | |
| # rtd = yaml.safe_load(f) | |
| # cog.outl(f'python-version: "{rtd["build"]["tools"]["python"]}"') | |
| # ]]] | |
| python-version: "3.12" | |
| # [[[end]]] | |
| - run: python -Im pip install --upgrade wheel nox | |
| - run: python -Im nox -e docs | |
| install-dev: | |
| name: Verify dev env on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version-file: .python-version-default | |
| cache: pip | |
| - run: python -Im pip install -e .[dev] | |
| - run: python -c 'import environ; print(environ.__version__)' | |
| # Ensure everything required is passing for branch protection. | |
| required-checks-pass: | |
| if: always() | |
| needs: | |
| - coverage | |
| - docs | |
| - install-dev | |
| - mypy | |
| 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) }} |