Skip to content

update README

update README #603

Workflow file for this run

# pre-commit workflow
#
# Ensures the codebase passes the pre-commit stack.
# We run this on GHA to catch issues in commits from contributors who haven't
# set up pre-commit.
name: pre-commit
on:
push:
branches:
- main
pull_request:
jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Cache $HOME/.local # Significantly speeds up Poetry Install
uses: actions/cache@v4
with:
path: ~/.local
key: dotlocal-${{ runner.os }}-${{ hashFiles('.github/workflows/tests.yml') }}
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
- name: Load pip cache
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: pip-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}
restore-keys: ${{ runner.os }}-pip
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install Belay
run: poetry install --no-interaction
- uses: pre-commit/[email protected]