Skip to content

Merge pull request #322 from naik-aakash/update_doc #1364

Merge pull request #322 from naik-aakash/update_doc

Merge pull request #322 from naik-aakash/update_doc #1364

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: Testing Linux
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.9"
cache: pip
cache-dependency-path: pyproject.toml
- uses: pre-commit/[email protected]
test:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0} # enables conda/mamba env activation by reading bash profile
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
split: [1, 2, 3, 4, 5, 6]
steps:
- name: Check out repo
uses: actions/checkout@v4
- name: Set up micromamba
uses: mamba-org/setup-micromamba@main
- name: Create mamba environment
run: |
micromamba create -n lobpy python=${{ matrix.python-version }} --yes
- name: Install uv
run: micromamba run -n lobpy pip install uv
- name: Install LobsterPy and dependencies
run: |
micromamba activate lobpy
uv pip install --upgrade pip
uv pip install --editable '.[tests,featurizer]'
- name: Test with pytest and coverage
# run this locally to update tests durations
# pytest --cov=lobsterpy --cov-append --splits 1 --group 1 --durations-path ./tests/test_data/.pytest-split-durations --store-durations
run: |
micromamba activate lobpy
pytest --cov=lobsterpy --cov-report term-missing --cov-append --splits 6 --group ${{ matrix.split }} -vv --durations-path ./tests/test_data/.pytest-split-durations
- name: Upload coverage
uses: actions/upload-artifact@v3
with:
name: coverage-${{ matrix.split }}
path: .coverage
coverage:
needs: test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install Coverage
run: |
python -m pip install coverage[toml]
- name: Download coverage artifacts
continue-on-error: true
uses: actions/download-artifact@v3
- name: Run coverage
continue-on-error: true
run: |
coverage combine coverage*/.coverage*
coverage report --show-missing
- name: Upload coverage reports to Codecov
uses: codecov/[email protected]
with:
token: ${{ secrets.CODECOV_TOKEN }}
slug: JaGeo/LobsterPy
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
cache: pip
cache-dependency-path: pyproject.toml
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs,featurizer]
- name: Build
run: sphinx-build -W docs _build