docs updates in prep for 1.0 release #693
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 | |
| - 'v*' | |
| tags: | |
| - 'v*' | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Github Actions supports ubuntu, windows, and macos virtual environments: | |
| # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners | |
| ci_tests: | |
| name: ${{ matrix.name }} | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: ${{ matrix.allow_failure }} | |
| strategy: | |
| matrix: | |
| include: | |
| - name: Code style checks | |
| os: ubuntu-latest | |
| python: 3.x | |
| toxenv: codestyle | |
| allow_failure: false | |
| - name: PEP 517 | |
| os: ubuntu-latest | |
| python: 3.x | |
| toxenv: pep517 | |
| allow_failure: false | |
| - name: Security audit | |
| os: ubuntu-latest | |
| python: 3.x | |
| toxenv: securityaudit | |
| allow_failure: false | |
| - name: Python 3.10 with coverage checking, all deps, and remote data | |
| os: ubuntu-latest | |
| python: '3.10' | |
| toxenv: py310-test-alldeps-cov | |
| toxposargs: --remote-data | |
| allow_failure: false | |
| - name: OS X - Python 3.10 | |
| os: macos-latest | |
| python: '3.10' | |
| toxenv: py310-test | |
| allow_failure: false | |
| - name: Windows - Python 3.11 | |
| os: windows-latest | |
| python: 3.11 | |
| toxenv: py311-test | |
| allow_failure: false | |
| # This also runs on cron but we want to make sure new changes | |
| # won't break this job at the PR stage. | |
| - name: Python 3.12 with latest dev versions of key dependencies, and remote data | |
| os: ubuntu-latest | |
| python: '3.12' | |
| toxenv: py312-test-devdeps | |
| toxposargs: --remote-data --run-slow | |
| allow_failure: true | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up python ${{ matrix.python }} on ${{ matrix.os }} | |
| uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install base dependencies | |
| run: python -m pip install --upgrade pip tox | |
| - name: Test/run with tox | |
| run: tox -e ${{ matrix.toxenv }} -- ${{ matrix.toxposargs }} | |
| - name: Upload coverage to codecov | |
| if: "contains(matrix.toxenv, '-cov')" | |
| uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0 | |
| with: | |
| file: ./coverage.xml | |
| verbose: true |