Reorganize docs and add a quickstart guide #95
Workflow file for this run
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: lint-and-test | |
on: | |
push: | |
branches: | |
- main | |
- feat/* | |
pull_request: | |
branches: | |
- main | |
- feat/* | |
jobs: | |
lint-and-test: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Install Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.9" | |
- name: Cache Poetry install | |
uses: actions/cache@v2 | |
with: | |
path: ~/.local | |
key: poetry-1.8.3-0 | |
- name: Install Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
version: 1.8.3 | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
- name: Cache Poetry dependencies | |
id: cache-poetry-deps | |
uses: actions/cache@v2 | |
with: | |
path: .venv | |
key: pydeps-${{ hashFiles('**/poetry.lock') }} | |
- run: poetry install --no-interaction --no-root | |
if: steps.cache-poetry-deps.outputs.cache-hit != 'true' | |
- name: Run Ruff | |
run: poetry run ruff check --output-format=github . | |
- name: Run Ruff formatter | |
run: poetry run ruff format --check . | |
- name: Run tests | |
run: poetry run pytest |