Improve formatting of the docs (#39) #53
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: Perform checks | |
permissions: | |
contents: read | |
on: | |
push: | |
branches: | |
- main | |
paths-ignore: | |
- '.github/ISSUE_TEMPLATE/*.yaml' | |
- '.github/CODEOWNERS' | |
- '.github/pull_request_template.md' | |
- 'docs/**/*.md' | |
- 'mkdocs.yml' | |
- 'README.md' | |
pull_request: | |
branches: | |
- main | |
paths-ignore: | |
- '.github/ISSUE_TEMPLATE/*.yaml' | |
- '.github/CODEOWNERS' | |
- '.github/pull_request_template.md' | |
- 'docs/**/*.md' | |
- 'mkdocs.yml' | |
- 'README.md' | |
env: | |
PIP_PROGRESS_BAR: "off" | |
PIP_DISABLE_PIP_VERSION_CHECK: "on" | |
POETRY_NO_INTERACTION: 1 | |
POETRY_VIRTUALENVS_IN_PROJECT: true | |
jobs: | |
unit-tests: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: [ '3.11', '3.12' ] # Define Python versions here | |
container: | |
image: python:${{ matrix.python-version }}-alpine # Use Python Docker images | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v4 | |
- uses: ./.github/actions/setup-poetry-project | |
with: | |
install_plugin: false | |
- name: Run Pytest | |
run: | | |
poetry run pytest | |
lint: | |
runs-on: ubuntu-latest | |
container: | |
image: python:3.12-alpine | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v4 | |
- uses: ./.github/actions/setup-poetry-project | |
with: | |
install_plugin: false | |
- name: Run ruff check | |
run: poetry run ruff check | |
- name: Run ruff format check | |
run: poetry run ruff format --check . |