summaryrefslogtreecommitdiff
path: root/.github/workflows/doctests.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows/doctests.yml')
-rw-r--r--.github/workflows/doctests.yml42
1 files changed, 42 insertions, 0 deletions
diff --git a/.github/workflows/doctests.yml b/.github/workflows/doctests.yml
new file mode 100644
index 0000000..0c56e5e
--- /dev/null
+++ b/.github/workflows/doctests.yml
@@ -0,0 +1,42 @@
+name: Documentation Tests
+
+on:
+ push:
+ pull_request:
+
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+jobs:
+ doctests:
+ runs-on: ubuntu-latest
+ services:
+ redis-stack:
+ image: redis/redis-stack-server:latest
+ options: >-
+ --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+ ports:
+ - 6379:6379
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.9
+ cache: 'pip'
+ - run: |
+ sudo apt update
+ sudo apt install -y redis-tools
+ - name: lint check
+ run: |
+ pip install -r dev_requirements.txt
+ pip install -r requirements.txt
+ isort --check-only --diff doctests/*.py
+ black --target-version py39 --check --diff doctests/*.py
+
+ - name: run tests
+ run: |
+ python setup.py build
+ python setup.py install
+ sh doctests/run_examples.sh