Skip to content

fix: readme

fix: readme #1535

Workflow file for this run

name: Checks and Tests
on: pull_request
jobs:
code_quality_check:
name: Check Code Quality
runs-on: '${{ matrix.os }}'
strategy:
matrix:
os:
- ubuntu-latest
python-version:
- '3.9'
tox-job:
- black-check
- isort-check
- flake8
- vulture
- bandit
- safety
- mypy
- pylint
- liccheck
- copyright-check
- check-manifest
- check_api_docs
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '${{ matrix.python-version }}'
- name: Install dependencies
run: pip install tox==3.25.1
- name: 'Run check ${{ matrix.tox-job }}'
run: |
tox -e ${{ matrix.tox-job }}
spell-check:
name: Check Spelling
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: rojopolis/[email protected]
with:
config_path: .spellcheck.yml
markdown-link-check:
name: Check Links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: .md-link-check.json
unit_tests:
name: Unit Tests
runs-on: '${{ matrix.os }}'
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
python-version:
- '3.8'
- '3.9'
- '3.10'
- '3.11'
- '3.12'
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '${{ matrix.python-version }}'
- name: Install dependencies
run: pip install tox==3.25.1
- name: Unit Tests
run: |
tox -e test-unit
shell: bash
- name: Coverage Report
run: tox -e coverage-report
integration_tests:
name: Integration tests
runs-on: '${{ matrix.os }}'
strategy:
matrix:
os:
- ubuntu-latest
- windows-latest
- macos-latest
python-version:
- 3.9
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '${{ matrix.python-version }}'
- name: Install dependencies
run: pip install tox==3.25.1
- name: Integration Tests
run: |
tox -e test-integration
third_party_tests:
name: Third Party Tests
runs-on: '${{ matrix.os }}'
strategy:
matrix:
os:
- ubuntu-latest
- windows-latest
- macos-latest
python-version:
- 3.9
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '${{ matrix.python-version }}'
- name: Install dependencies
run: pip install tox==3.25.1
- name: Third Party Tests
run: tox -e test-third-party
continue-on-error: true