tox #1863
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: tox | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| release: | |
| types: [published] | |
| # Run the tox tests every 8 hours. | |
| # This will help to identify faster if | |
| # there is a CI failure related to a | |
| # change in any dependency. | |
| schedule: | |
| - cron: "0 */8 * * *" | |
| # Run on demand | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| FORCE_COLOR: 1 # tox, pytest | |
| PY_COLORS: 1 | |
| jobs: | |
| prepare: | |
| name: prepare | |
| runs-on: ubuntu-24.04 | |
| outputs: | |
| matrix: ${{ steps.generate_matrix.outputs.matrix }} | |
| steps: | |
| - name: Determine matrix | |
| id: generate_matrix | |
| uses: coactions/dynamic-matrix@v4 | |
| with: | |
| min_python: "3.8" | |
| max_python: "3.13" | |
| default_python: "3.10" | |
| other_names: | | |
| lint | |
| pkg | |
| py38:tox -e py38 | |
| py39:tox -e py39 | |
| py310:tox -e py310; tox -e py310-devel | |
| py311:tox -e py311; tox -e py311-devel | |
| py312:tox -e py312; tox -e py312-devel | |
| py313:tox -e py313-devel | |
| py312-macos:tox -e py312; tox -e py312-devel | |
| platforms: linux,macos | |
| skip_explode: "1" | |
| build: | |
| name: ${{ matrix.name }} | |
| runs-on: ${{ matrix.os || 'ubuntu-24.04' }} | |
| continue-on-error: ${{ contains(matrix.name, 'integration') && true || false }} | |
| needs: | |
| - prepare | |
| defaults: | |
| run: | |
| shell: ${{ matrix.shell || 'bash'}} | |
| strategy: | |
| fail-fast: false | |
| matrix: ${{ fromJson(needs.prepare.outputs.matrix) }} | |
| # max-parallel: 5 | |
| # The matrix testing goal is to cover the *most likely* environments | |
| # which are expected to be used by users in production. Avoid adding a | |
| # combination unless there are good reasons to test it, like having | |
| # proof that we failed to catch a bug by not running it. Using | |
| # distribution should be preferred instead of custom builds. | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # needed by setuptools-scm | |
| submodules: true | |
| - name: Set pre-commit cache | |
| uses: actions/cache@v4 | |
| if: ${{ matrix.passed_name == 'lint' }} | |
| with: | |
| path: | | |
| ~/.cache/pre-commit | |
| key: pre-commit-${{ matrix.name || matrix.passed_name }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Set up Python ${{ matrix.python_version || '3.10' }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| cache: pip | |
| python-version: ${{ matrix.python_version || '3.10' }} | |
| # cache-dependency-path: "*requirements*.txt" | |
| - name: Install tox | |
| run: | | |
| python3 -m pip install --upgrade pip wheel tox | |
| # sequential run improves browsing experience (almost no speed impact) | |
| - run: ${{ matrix.command }} | |
| - run: ${{ matrix.command2 }} | |
| if: ${{ matrix.command2 }} | |
| - run: ${{ matrix.command3 }} | |
| if: ${{ matrix.command3 }} | |
| - run: ${{ matrix.command4 }} | |
| if: ${{ matrix.command4 }} | |
| - run: ${{ matrix.command5 }} | |
| if: ${{ matrix.command5 }} | |
| - name: Archive logs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: logs-${{ matrix.name }}.zip | |
| if-no-files-found: error | |
| include-hidden-files: true | |
| path: | | |
| .tox/**/log/ | |
| .tox/**/.coverage* | |
| .tox/**/coverage.xml | |
| - name: Report failure if git reports dirty status | |
| run: | | |
| if [[ -n $(git status -s) ]]; then | |
| # shellcheck disable=SC2016 | |
| echo -n '::error file=git-status::' | |
| printf '### Failed as git reported modified and/or untracked files\n```\n%s\n```\n' "$(git status -s)" | tee -a "$GITHUB_STEP_SUMMARY" | |
| exit 99 | |
| fi | |
| # https://github.com/actions/toolkit/issues/193 | |
| check: | |
| if: always() | |
| permissions: | |
| id-token: write | |
| checks: read | |
| needs: | |
| - build | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| # checkout needed for codecov action which needs codecov.yml file | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python # likely needed for coverage | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - run: pip3 install 'coverage>=7.5.1' | |
| - name: Merge logs into a single archive | |
| uses: actions/upload-artifact/merge@v4 | |
| with: | |
| name: logs.zip | |
| pattern: logs-*.zip | |
| include-hidden-files: true | |
| # artifacts like py312.zip and py312-macos do have overlapping files | |
| separate-directories: true | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: logs.zip | |
| path: . | |
| # - name: Check for expected number of coverage.xml reports | |
| # run: | | |
| # JOBS_PRODUCING_COVERAGE=8 | |
| # if [ "$(find . -name coverage.xml | wc -l | bc)" -ne "${JOBS_PRODUCING_COVERAGE}" ]; then | |
| # echo "::error::Number of coverage.xml files was not the expected one (${JOBS_PRODUCING_COVERAGE}): $(find . -name coverage.xml |xargs echo)" | |
| # exit 1 | |
| # fi | |
| # - name: Upload coverage data | |
| # uses: codecov/codecov-action@v4 | |
| # with: | |
| # name: ${{ matrix.passed_name }} | |
| # # verbose: true # optional (default = false) | |
| # fail_ci_if_error: true | |
| # use_oidc: true # cspell:ignore oidc | |
| # - name: Check codecov.io status | |
| # if: github.event_name == 'pull_request' | |
| # uses: coactions/codecov-status@main | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| - name: Delete Merged Artifacts | |
| uses: actions/upload-artifact/merge@v4 | |
| with: | |
| delete-merged: true | |
| pypi: | |
| name: Publish to PyPI registry | |
| needs: check | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| environment: release # approval | |
| runs-on: ubuntu-24.04 | |
| permissions: | |
| id-token: write | |
| env: | |
| FORCE_COLOR: 1 | |
| PY_COLORS: 1 | |
| TOXENV: pkg | |
| steps: | |
| - name: Switch to using Python 3.10 by default | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install tox | |
| run: python3 -m pip install --user "tox>=4.0.0" | |
| - name: Check out src from Git | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # needed by setuptools-scm | |
| submodules: true | |
| - name: Build dists | |
| run: python3 -m tox | |
| - name: Publish to pypi.org | |
| if: >- # "create" workflows run separately from "push" & "pull_request" | |
| github.event_name == 'release' | |
| uses: pypa/gh-action-pypi-publish@release/v1 |