pytest-poetry.yml

## action file inspired by https://jacobian.org/til/github-actions-poetry/

name: pytest (via poetry)

on:
  push:
    branches:
    - master
    tags:
      - run-pytest*
      - py3-pytest*
      - "*-[0-9]+.*"
  pull_request:
    branches:
    - master
    - devel

jobs:
  pytest-poetry:
    # runs-on: ubuntu-latest
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4

    - name: Cache APT Packages
      uses: awalsh128/cache-apt-pkgs-action@v1.4.2
      with:
        packages: xmlstarlet
        version: 1.0

    # If you wanted to use multiple Python versions, you'd have specify a
    # matrix in the job and reference the matrix python version here.
    - uses: actions/setup-python@v5.3.0
      with:
        python-version: "3.10"

    # Cache the installation of Poetry itself, e.g. the next step. This
    # prevents the workflow from installing Poetry every time, which can be
    # slow. Note the use of the Poetry version number in the cache key, and
    # the "-0" suffix: this allows you to invalidate the cache manually
    # if/when you want to upgrade Poetry, or if something goes wrong (could be
    # done mildly cleaner by using an environment variable).
    - name: cache poetry install
      uses: actions/cache@v4
      with:
        path: ~/.local
        key: poetry-1.8.2-0

    # Install Poetry. You could do this manually, or there are several actions
    # that do this. `snok/install-poetry` seems to be minimal yet complete,
    # and really just calls out to Poetry's default install script, which
    # feels correct. I pin the Poetry version here because Poetry does
    # occasionally change APIs between versions and I don't want my actions to
    # break if it does.
    #
    # The key configuration value here is `virtualenvs-in-project: true`: this
    # creates the venv as a `.venv` in your testing directory, which allows
    # the next step to easily cache it.
    - uses: snok/install-poetry@v1
      with:
        version: 1.8.2
        virtualenvs-create: true
        virtualenvs-in-project: true

    # Cache your dependencies (i.e. all the stuff in your `pyproject.toml`).
    # Note the cache key: if you're using multiple Python versions, or
    # multiple OSes, you'd need to include them in the cache key. I'm not, so
    # it can be simple and just depend on the poetry.lock.
    - name: cache deps
      id: cache-deps
      uses: actions/cache@v4
      with:
        path: .venv
        key: pydeps-${{ hashFiles('**/poetry.lock') }}

    # Install dependencies. `--no-root` means "install all dependencies but
    # not the project itself", which is what you want to avoid caching _your_
    # code. The `if` statement ensures this only runs on a cache miss.
    - run: scripts/run-poetry.sh install --no-interaction --no-root
      if: steps.cache-deps.outputs.cache-hit != 'true'

    # Now install _your_ project. This isn't necessary for many types of
    # projects -- particularly things like Django apps don't need this. But
    # it's a good idea since it fully-exercises the pyproject.toml and makes
    # that if you add things like console-scripts at some point that they'll
    # be installed and working.
    - run: scripts/run-poetry.sh install --no-interaction

    # And finally run the tests.
    - run: scripts/run-poetry.sh run pytest --cov -vv