Added docs. (#45)

Signed-off-by: Pavel Kirilin <[email protected]>

Author: s3rius

.github/workflows/release.yml

@@ -6,18 +6,41 @@ on:
       - "*"
 
 jobs:
+  deploy_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        uses: borales/[email protected]
+        with:
+          cmd: install # will run `yarn install` command
+      - name: Build docs
+        uses: borales/[email protected]
+        with:
+          cmd: docs:build -d docs_dist # will run `docs:build -d docs_dist` command
+      - name: Setup git
+        run: |
+          git config --global lfs.allowincompletepush true
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          external_repository: taskiq-python/taskiq-python.github.io
+          publish_dir: ./docs_dist
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Install poetry
+        run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.9"
       - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
+        run: poetry install
       - name: Release package
         env:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}

.github/workflows/test.yml

@@ -3,48 +3,29 @@ name: Testing taskiq
 on: push
 
 jobs:
-  black:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run black check
-        run: poetry run black --check .
-  flake8:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run flake8 check
-        run: poetry run flake8 --count .
-  mypy:
+  lint:
+    strategy:
+      matrix:
+        cmd:
+          - black
+          - flake8
+          - isort
+          - mypy
+          - autoflake
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Install poetry
+        run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.9"
+          cache: 'poetry'
       - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run mypy check
-        run: poetry run mypy .
+        run: poetry install
+      - name: Run lint check
+        run: poetry run pre-commit run -a ${{ matrix.cmd }}
   pytest:
     permissions:
       checks: write
@@ -57,22 +38,19 @@ jobs:
     runs-on: "${{ matrix.os }}"
     steps:
       - uses: actions/checkout@v2
+      - name: Install poetry
+        run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "${{ matrix.py_version }}"
-      - name: Update pip
-        run: python -m pip install -U pip
-      - name: Install poetry
-        run: python -m pip install poetry
+          cache: 'poetry'
       - name: Install deps
         run: poetry install
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
       - name: Run pytest check
         run: poetry run pytest -vv -n auto --cov="taskiq" .
       - name: Generate report
-        run: coverage xml
+        run: poetry run coverage xml
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v3
         if: matrix.os == 'ubuntu-latest' && matrix.py_version == '3.9'

.gitignore

@@ -160,3 +160,8 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 .vscode/
+
+## For docs
+node_modules
+.temp
+.cache