Allow positional args in exception
#417
Workflow file for this run
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: | |
| branches: [main] | |
| workflow_dispatch: | |
| env: | |
| FORCE_COLOR: "1" # Make tools pretty. | |
| PIP_DISABLE_PIP_VERSION_CHECK: "1" | |
| PIP_NO_PYTHON_VERSION_WARNING: "1" | |
| # For re-actors/checkout-python-sdist | |
| SETUPTOOLS_SCM_PRETEND_VERSION: "1.0" # hard-code version for predictable sdist names | |
| sdist-artifact: python-package-distributions | |
| sdist-name: structlog-1.0.tar.gz | |
| # N.B. default Python version for setup-python comes from the .python-version | |
| # file at the root of the project. | |
| permissions: {} | |
| jobs: | |
| build-sdist: | |
| name: 📦 Build the source distribution | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| 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 & API Mypy on ${{ matrix.python-version }} | |
| needs: build-sdist | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| - "3.8" | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| 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 tox | |
| - run: python -Im tox run -f py$(echo ${{ matrix.python-version }} | tr -d .) | |
| - run: python -Im tox run -e mypy-api | |
| - 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. | |
| needs: tests | |
| 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 | |
| - 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: Type-check package | |
| 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: | |
| allow-prereleases: true | |
| cache: pip | |
| - name: Prepare & run tox | |
| run: | | |
| python -Im pip install tox | |
| python -Im tox run -e mypy-pkg | |
| 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: | |
| # Keep in sync with tox.ini/docs & .readthedocs.yaml | |
| python-version: "3.11" | |
| cache: pip | |
| - run: python -Im pip install tox | |
| - run: python -Im tox run -e docs | |
| 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: | |
| cache: pip | |
| - run: python -Im pip install -e .[dev] | |
| - run: python -Ic 'import structlog; print(structlog.__version__)' | |
| # Ensure everything required is passing for branch protection. | |
| required-checks-pass: | |
| if: always() | |
| needs: | |
| - coverage | |
| - docs | |
| - install-dev | |
| 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) }} | |
| colors: | |
| name: Visual check for color settings using env variables | |
| 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 | |
| - run: python -Im pip install tox | |
| - run: python -Im tox run -f color |