Improve docstrings and test coverage #46
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: Tests | |
on: [push, pull_request, workflow_dispatch] | |
jobs: | |
tests: | |
name: | |
Test on ${{ matrix.os }}, Python ${{ matrix.python-version }}${{ matrix.experimental && ', latest | |
dependencies' || '' }} | |
runs-on: ${{ matrix.os }} | |
defaults: | |
run: | |
shell: bash -el {0} | |
strategy: | |
fail-fast: false | |
matrix: | |
os: [ubuntu-latest] | |
python-version: ["3.9", "3.10", "3.11"] | |
experimental: [false] | |
include: | |
- os: ubuntu-latest | |
python-version: "3.11" | |
experimental: true | |
- os: ubuntu-latest | |
python-version: "3.11" | |
experimental: false | |
coverage: true | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- name: Set up micromamba | |
uses: mamba-org/setup-micromamba@v1 | |
with: | |
environment-file: ${{ matrix.experimental && 'ci/environment_latest.yaml' || 'ci/environment.yaml' }} | |
create-args: >- | |
python=${{ matrix.python-version }} | |
init-shell: >- | |
bash | |
- name: Install package | |
run: | | |
pip uninstall -y matplotlib # have matplotlib reinstalled for consistent plotting tests | |
pip install -e ".[dev]" | |
- name: Test with pytest | |
run: | | |
pytest # See pyproject.toml for cov options | |
env: | |
HDF5_USE_FILE_LOCKING: false | |
- name: Upload coverage reports to Codecov | |
uses: codecov/codecov-action@v4 | |
if: matrix.coverage | |
with: | |
token: ${{ secrets.CODECOV_TOKEN }} | |
files: coverage.xml | |
- name: Coveralls Parallel | |
uses: coverallsapp/github-action@v2 | |
if: matrix.coverage | |
with: | |
parallel: true | |
files: lcov.info | |
end-coveralls: | |
needs: [tests] | |
if: ${{ always() }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Coveralls Finished | |
uses: coverallsapp/github-action@v2 | |
with: | |
parallel-finished: true |