Skip to content

Update README.md

Update README.md #151

Workflow file for this run

name: CI Build
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main
schedule:
- cron: '0 0 1 * *'
jobs:
first_check:
name: first code check / python-3.10 / ubuntu-latest
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Python info
run: |
which python3
python3 --version
- name: Build package and create dev environment
run: |
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -e .[dev]
- name: Check style against standards using prospector
shell: bash -l {0}
run: prospector --profile linter_profile -o grouped -o pylint:pylint-report.txt --zero-exit
- name: Run unit test / Test coverage with Scrutinizer
run: |
coverage run --source=mcfly -m pytest
python3 -m pip install scrutinizer-ocular
ocular --access-token ${{ secrets.SCRUTINIZER_OCULAR_TOKEN }}
basic_checks:
name: Run tests across OS and versions / python-${{ matrix.python-version }} / ${{ matrix.os }}
runs-on: ${{ matrix.os }}
needs: first_check
strategy:
fail-fast: false
matrix:
os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
python-version: ['3.10', '3.11']
exclude:
# already tested in first_check job
- python-version: 3.10
os: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Python info
run: |
which python3
python3 --version
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -e .[dev]
- name: Run unit tests
run: pytest -v
- name: Verify that we can build the package
run: python3 setup.py sdist bdist_wheel