Add .readthedocs.yaml #35
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - '**' | |
| pull_request: | |
| env: | |
| MPLBACKEND: Agg | |
| PYTEST_ADDOPTS: --color=yes | |
| GITHUB_PR_NUMBER: ${{ github.event.number }} | |
| jobs: | |
| tests: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| include: | |
| - os: ubuntu-latest | |
| python-version: "3.10" | |
| install-method: mamba | |
| - os: ubuntu-latest | |
| python-version: "3.11" | |
| install-method: mamba | |
| - os: ubuntu-latest | |
| python-version: "3.11" | |
| install-method: pip | |
| # macos 13 image is x86-based | |
| - os: macos-13 | |
| python-version: "3.10" | |
| install-method: pip | |
| # macos 14 image is arm64 based | |
| - os: macos-14 | |
| python-version: "3.11" | |
| install-method: mamba | |
| defaults: | |
| run: | |
| # We need login shells (-l) for micromamba to work. | |
| shell: bash -leo pipefail {0} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Prepare mamba installation | |
| if: matrix.install-method == 'mamba' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| run: | | |
| # setup correct python version | |
| sed -i -e "s/- python.*/- python=$PYTHON_VERSION/g" environment.yml | |
| - name: mamba setup | |
| if: matrix.install-method == 'mamba' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: environment.yml | |
| cache-downloads: true | |
| - name: Python setup | |
| if: matrix.install-method == 'pip' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| check-latest: true | |
| - if: matrix.install-method == 'pip' && runner.os == 'macOS' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| name: Fix Python PATH on macOS | |
| # See https://github.com/actions/setup-python/issues/132 and | |
| # https://github.com/actions/setup-python/issues/132#issuecomment-779406058 | |
| # Login shells on macOS prepend system paths, so we need to | |
| # prepend the python path from actions/setup-python. | |
| # Micromamba sets up ~/.bash_profile, where we need to set the path now. | |
| run: | | |
| tee -a ~/.bash_profile <<<'export PATH="$pythonLocation/bin:$PATH"' | |
| - name: Install dependencies | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| run: | | |
| python --version | |
| pip install pytest-cov restructuredtext-lint pytest-xdist 'coverage!=6.3.0' | |
| pip install -e .[all] | |
| pip freeze | |
| pip list | |
| - name: List installed package versions (conda) | |
| if: matrix.environment-type == 'mamba' | |
| run: micromamba list | |
| - name: Tests | |
| run: | | |
| pytest --cov --cov-report=xml | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install doc dependencies | |
| run: | | |
| sudo apt update --yes && sudo apt install --yes git | |
| pip install -U pip towncrier | |
| - name: Produce Changelog | |
| run: | | |
| towncrier build --yes --version==0.0.0 |