Skip to content
Main

Update readmes #15

Sign in to view logs

Update readmes

Update readmes #15

Workflow file for this run

.github/workflows/main.yml at 94a1adb
name: Main
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
jobs:
quality:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v4
- uses: actions/cache@v4
with:
path: ~/.cache/pre-commit
key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
- name: Set up the environment
uses: ./.github/actions/setup-python-env
- name: Run checks
run: make check
run-tests:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
fail-fast: false
max-parallel: 5
defaults:
run:
shell: bash
steps:
- name: Check out
uses: actions/checkout@v4
- name: Extract model data
run: |
# Extract tide modelling test files
tar -xvzf ./tests/data/tide_models_tests.tar.gz -C ./tests/data
# Add environment variable to allow functions to locate data
echo "DEA_TOOLS_TIDE_MODELS=./tests/data/tide_models_tests" >> $GITHUB_ENV
- name: Set up the environment
uses: ./.github/actions/setup-python-env
with:
python-version: ${{ matrix.python-version }}
- name: Run Python unit tests
run: uv run python -m pytest tests --cov --cov-config=pyproject.toml --cov-report=xml --verbose
- name: Run Jupyter Notebook integration tests
run: uv run python -m pytest --nbval-lax docs/notebooks/Model_tides.ipynb
- name: Check typing
run: uv run mypy
- name: Upload coverage reports to Codecov with GitHub Action on Python 3.10
uses: codecov/codecov-action@v4
if: ${{ matrix.python-version == '3.10' }}
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
check-docs:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v4
- name: Set up the environment
uses: ./.github/actions/setup-python-env
- name: Check if documentation can be built
run: uv run mkdocs build -s