Include a function #275

	name: Test and build

	on: [push, pull_request, release]

	jobs:
	qa:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: pre-commit/[email protected]

	check-links:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: gaurav-nelson/github-action-markdown-link-check@v1
	name: Check links in markdown files
	with:
	use-quiet-mode: 'yes'
	use-verbose-mode: 'yes'

	test:
	needs: qa
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ windows-latest, ubuntu-latest, macos-latest ]
	python-version: [ "3.8", "3.9", "3.10", "3.11" ]

	steps:
	- uses: actions/checkout@v3

	- uses: actions/setup-python@v4
	with:
	python-version: ${{ matrix.python-version }}

	- name: Install Poetry
	uses: abatilo/[email protected]
	with:
	poetry-version: 1.5.1

	- name: Install dependencies
	run: poetry install --with dev

	- name: Run tests
	run: poetry run pytest

	- name: Upload coverage to Codecov
	if: success() && (matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9)
	uses: codecov/codecov-action@v3


	deploy-docs:
	needs: test
	runs-on: ubuntu-latest
	if: github.ref == 'refs/heads/main'

	steps:
	- uses: actions/checkout@v3

	- uses: actions/setup-python@v4
	with:
	python-version: 3.9

	- name: Install Poetry
	uses: abatilo/[email protected]
	with:
	poetry-version: 1.5.1

	- name: Install dependencies
	run: poetry install --with docs

	- name: Deploy Docs
	run: poetry run mkdocs gh-deploy --force

Provide feedback