Skip to content
FloPy continuous integration

chore: add codespell configuration and check with lint CI job #2134

Sign in to view logs

chore: add codespell configuration and check with lint CI job

chore: add codespell configuration and check with lint CI job #2134

Workflow file for this run

.github/workflows/commit.yml at bb073ef
name: FloPy continuous integration
on:
push:
pull_request:
branches:
- master
- develop
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: Build
runs-on: ubuntu-latest
defaults:
run:
shell: bash
timeout-minutes: 10
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.9
cache: 'pip'
cache-dependency-path: pyproject.toml
- name: Install Python dependencies
run: |
pip install --upgrade pip
pip install build twine
pip install .
python -c "import flopy; print(f'{flopy.__version__}')"
- name: Build package
run: python -m build
- name: Check package
run: twine check --strict dist/*
lint:
name: Lint
runs-on: ubuntu-latest
defaults:
run:
shell: bash
timeout-minutes: 10
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.9
cache: 'pip'
cache-dependency-path: pyproject.toml
- name: Install Python dependencies
run: |
pip install .
pip install ".[lint]"
- name: Lint
run: ruff check .
- name: Check format
run: ruff format . --check
- name: Check spelling
run: codespell
- name: Check CITATION.cff
run: |
cffconvert --validate
cffconvert -f apalike
cffconvert -f bibtex
smoke:
name: Smoke test
runs-on: ubuntu-latest
defaults:
run:
shell: bash
timeout-minutes: 10
env:
PYTHON_VERSION: 3.9
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
cache: 'pip'
cache-dependency-path: pyproject.toml
- name: Install Python dependencies
run: |
pip install --upgrade pip
pip install .
pip install ".[test, optional]"
- name: Install Modflow executables
uses: modflowpy/install-modflow-action@v1
- name: Smoke test
working-directory: autotest
run: pytest -v -n=auto --smoke --cov=flopy --cov-report=xml --durations=0 --keep-failed=.failed
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload failed test outputs
uses: actions/upload-artifact@v4
if: failure()
with:
name: failed-smoke-${{ runner.os }}-${{ env.PYTHON_VERSION }}
path: autotest/.failed/**
- name: Upload coverage
if: github.repository_owner == 'modflowpy' && (github.event_name == 'push' || github.event_name == 'pull_request')
uses: codecov/codecov-action@v3
with:
files: autotest/coverage.xml
test:
name: Test
needs: smoke
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ ubuntu-latest, macos-latest, windows-latest ]
python-version: [ 3.9, "3.10", "3.11", "3.12" ]
defaults:
run:
shell: bash -l {0}
timeout-minutes: 60
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Micromamba
uses: mamba-org/setup-micromamba@v1
with:
environment-file: etc/environment.yml
cache-environment: true
cache-downloads: true
create-args: >-
python=${{ matrix.python-version }}
init-shell: >-
bash
powershell
- name: Install FloPy
run: pip install .
- name: Install Modflow-related executables
uses: modflowpy/install-modflow-action@v1
- name: Install Modflow dev build executables
uses: modflowpy/install-modflow-action@v1
with:
repo: modflow6-nightly-build
- name: Install triangle (macOS workaround)
if: runner.os == 'macOS'
uses: modflowpy/install-modflow-action@v1
with:
repo: executables
ostag: mac
subset: triangle
- name: Update package classes
run: python -m flopy.mf6.utils.generate_classes --ref develop --no-backup
- name: Run tests
working-directory: autotest
run: |
pytest -v -m="not example" -n=auto --cov=flopy --cov-append --cov-report=xml --durations=0 --keep-failed=.failed --dist loadfile
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Report coverage
working-directory: autotest
run: coverage report
- name: Upload failed test outputs
uses: actions/upload-artifact@v4
if: failure()
with:
name: failed-${{ matrix.os }}-${{ matrix.python-version }}
path: autotest/.failed/**
- name: Upload coverage
if: github.repository_owner == 'modflowpy' && (github.event_name == 'push' || github.event_name == 'pull_request')
uses: codecov/codecov-action@v3
with:
files: autotest/coverage.xml