Update Github actions and pre-commit config files (#230)

Author: joowani

.github/workflows/build.yaml

@@ -1,55 +1,72 @@
 name: Build
 on:
-  workflow_dispatch:
   push:
     branches: [ main, dev ]
   pull_request:
     branches: [ main, dev ]
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: Run the build with tmate debugging
+        required: false
+        default: false
+
 jobs:
   build:
-    name: Test
     runs-on: ubuntu-latest
+
     strategy:
       matrix:
-        python-version: [ 3.7, 3.8, 3.9 ]
+        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Fetch complete history for all tags and branches
+        run: git fetch --prune --unshallow
+
       - name: Create ArangoDB Docker container
         run: >
           docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd
           arangodb/arangodb:3.7.7 --server.jwt-secret-keyfile=/tmp/keyfile
+
       - name: Copy Foxx service zip into ArangoDB Docker container
         run: docker cp tests/static/service.zip arango:/tmp/service.zip
+
       - name: Copy keyfile into ArangoDB Docker container
         run: docker cp tests/static/keyfile arango:/tmp/keyfile
+
       - name: Start ArangoDB Docker container
         run: docker start arango
-      - name: Fetch complete history for all tags and branches
-        run: git fetch --prune --unshallow
+
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Setup pip
-        run: python -m pip install --upgrade pip setuptools wheel
-      - name: Install packages
+
+      - name: Start tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+      - name: Run pre-commit checks
+        uses: pre-commit/[email protected]
+
+      - name: Install package
         run: pip install .[dev]
-      - name: Run black
-        run: black --check .
-      - name: Run flake8
-        run: flake8 .
-      - name: Run isort
-        run: isort --check --profile=black .
-      - name: Run mypy
-        run: mypy arango
-      - name: Run pytest
+
+      - name: Run unit tests
         run: py.test --complete --cov=arango --cov-report=xml
+
       - name: Run Sphinx doctest
         run: python -m sphinx -b doctest docs docs/_build
-      - name: Run Sphinx HTML
+
+      - name: Generate Sphinx HTML
         run: python -m sphinx -b html -W docs docs/_build
-      - name: Upload coverge to Codecov
-        uses: codecov/codecov-action@v2
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
         if: matrix.python-version == '3.8'
         with:
           fail_ci_if_error: false

.pre-commit-config.yaml

@@ -1,32 +1,41 @@
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    # See https://pre-commit.com/hooks.html
     hooks:
-      - id: check-case-conflict
-      - id: check-executables-have-shebangs
-      - id: check-json
-      - id: check-merge-conflict
-      - id: check-symlinks
-      - id: check-toml
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: mixed-line-ending
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
+    -   id: check-case-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-toml
+    -   id: check-xml
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: mixed-line-ending
+    -   id: pretty-format-json
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
     hooks:
-      - id: black
-  - repo: https://github.com/timothycrosley/isort
+    -   id: black
+
+-   repo: https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:
-      - id: isort
+    -   id: isort
         args: [ --profile, black ]
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.931
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
     hooks:
-      - id: mypy
-        files: ^arango/
-        additional_dependencies: ['types-requests']
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 4.0.1
+    -   id: flake8
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.991
     hooks:
-      - id: flake8
+    -   id: mypy
+        files: ^arango/
+        additional_dependencies: ['types-requests', "types-setuptools"]

docs/analyzer.rst

@@ -32,4 +32,4 @@ to `ArangoDB manual`_.
     # Delete an analyzer.
     db.delete_analyzer('test_analyzer', ignore_missing=True)
 
-Refer to :ref:`StandardDatabase` class for API specification.
+Refer to :ref:`StandardDatabase` class for API specification.

docs/serializer.rst

@@ -19,4 +19,4 @@ initialization. They must be callables that take a single argument.
         deserializer=json.loads
     )
 
-See :ref:`ArangoClient` for API specification.
+See :ref:`ArangoClient` for API specification.

docs/transaction.rst

@@ -121,4 +121,4 @@ Javascript code in a transaction.
     assert result is True
     assert 'Lucy' in students
     assert 'Greg' in students
-    assert 'Dona' not in students
+    assert 'Dona' not in students

docs/user.rst

@@ -93,4 +93,4 @@ these operations can only be performed by admin users via ``_system`` database.
         collection='students'
     )
 
-See :ref:`StandardDatabase` for API specification.
+See :ref:`StandardDatabase` for API specification.

tests/static/keyfile

@@ -1 +1 @@
-secret
+secret