Integrate with Starbase

.editorconfig

@@ -0,0 +1,43 @@
+# Editor configuration options.
+# See: https://spec.editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[.editorconfig]
+max_line_length = off
+
+[Makefile]
+indent_style = tab
+
+[{*.py,*.pyi}]
+max_line_length = 88
+
+[{*.bash,*.sh,*.zsh}]
+indent_size = 2
+tab_width = 2
+
+[{*.har,*.json,*.json5}]
+indent_size = 2
+max_line_length = off
+
+[{*.markdown,*.md,*.rst}]
+max_line_length = off
+ij_visual_guides = none
+
+[{*.toml,Cargo.lock,Cargo.toml.orig,Gopkg.lock,Pipfile,poetry.lock}]
+max_line_length = off
+
+[{*.ini, *.cfg}]
+max_line_length = off
+
+[{*.yaml,*.yml}]
+indent_size = 2
+max_line_length = off

.github/ISSUE_TEMPLATE/bug.yaml

@@ -58,4 +58,3 @@ body:
       render: shell
     validations:
       required: true
-

.github/workflows/snap.yaml

@@ -32,7 +32,7 @@ jobs:
         run: |
           if [[ "${{ github.event_name }}" == "pull_request" ]]
           then
-            echo "branch=pr-${{ github.event.number }}" >> "$GITHUB_OUTPUT"            
+            echo "branch=pr-${{ github.event.number }}" >> "$GITHUB_OUTPUT"
           else
             branch=$(echo ${GITHUB_REF#refs/*/} | sed -e 's|feature/\(.*\)|\1|')
             echo "branch=$branch" >> "$GITHUB_OUTPUT"

.github/workflows/spread-large.yaml

@@ -1,9 +1,9 @@
 name: Spread (large)
 on:
   pull_request:
-    types: [ labeled ]
+    types: [labeled]
   schedule:
-    - cron: "0 2 * * 0,3" # run at 2 AM on Sundays and Wednesdays
+    - cron: "0 2 * * 0,3"  # run at 2 AM on Sundays and Wednesdays
 
 jobs:
   snap-build:

.github/workflows/tests.yaml

@@ -1,108 +1,143 @@
 name: Tests
 
 on:
-  pull_request:
   push:
     branches:
-      - main
+      - "main"
+      - "feature/*"
+      - "hotfix/*"
+      - "release/*"
+      - "renovate/*"
+  pull_request:
 
 jobs:
-  linters:
+  lint:
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout code
+      - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           submodules: true
+      - name: conventional commits
+        uses: webiny/[email protected]
       - name: Install packages
         run: |
           sudo apt update
           sudo apt install -y libapt-pkg-dev aspell aspell-en
-      - name: Set up Python 3.10
+      - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
-      - name: Install python packages and dependencies
-        run: |
-          pip install -U wheel -r requirements-jammy.txt -r requirements.txt -r requirements-dev.txt
-          pip install -e .
-      - name: Run black
-        run: |
-          make test-black
-      - name: Run codespell
-        run: |
-          make test-codespell
-      - name: Run flake8
-        run: |
-          make test-flake8
-      - name: Run isort
-        run: |
-          make test-isort
-      - name: Run mypy
-        run: |
-          make test-mypy
-      - name: Run pydocstyle
-        run: |
-          make test-pydocstyle
-      - name: Run pyright
-        run: |
-          sudo snap install --classic node
-          sudo snap install --classic pyright
-          make test-pyright
-      - name: Run pylint
-        run: |
-          make test-pylint
-      - name: Run sphinx-lint
-        run: |
-          make test-sphinx-lint
-      - name: Run shellcheck
-        run: |
-          sudo snap install shellcheck
-          make test-shellcheck
-      - name: Run linkcheck,woke,spelling
-        run: |
-          sudo snap install woke
-          make test-docs
-
-  tests:
+          python-version: '3.10'
+          cache: 'pip'
+      - name: Configure environment
+        run: |
+          echo "::group::Begin snap install"
+          echo "Installing snaps in the background while running apt and pip..."
+          sudo snap install --no-wait --classic pyright
+          sudo snap install --no-wait shellcheck
+          echo "::endgroup::"
+          echo "::group::pip install"
+          python -m pip install tox
+          echo "::endgroup::"
+          echo "::group::Create virtual environments for linting processes."
+          tox run --colored yes -m lint --notest
+          echo "::endgroup::"
+          echo "::group::Wait for snap to complete"
+          snap watch --last=install
+          echo "::endgroup::"
+      - name: Run Linters
+        run: tox run --skip-pkg-install --no-list-dependencies --colored yes -m lint
+  unit:
     strategy:
       matrix:
-        os: [ubuntu-22.04, windows-2019]
-        python-version: ["3.10", "3.12"]
-
-    runs-on: ${{ matrix.os }}
+        platform: [ubuntu-22.04, windows-2019]
+    runs-on: ${{ matrix.platform }}
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
+      - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install python packages and dependencies
-        run: |
-          pip install -U wheel
+          python-version: |
+            3.10
+            3.12
+          cache: 'pip'
       - name: Install Ubuntu-specific dependencies
-        if: ${{ startsWith(matrix.os, 'ubuntu') }}
+        if: ${{ startsWith(matrix.platform, 'ubuntu') }}
         run: |
           sudo apt update
-          sudo apt install -y python3-pip python3-setuptools python3-wheel python3-venv libapt-pkg-dev
+          sudo apt install -y libapt-pkg-dev
       - name: Install Ubuntu 22.04-specific dependencies
-        if: ${{ matrix.os == 'ubuntu-22.04' }}
+        if: ${{ matrix.platform == 'ubuntu-22.04' }}
         run: |
-          pip install -U -r requirements-jammy.txt
           # 22.04 is the only one that has an 'umoci' package
           sudo apt install -y umoci
-      - name: Install dependencies
-        run: |
-          pip install -U -r requirements.txt -r requirements-dev.txt
-          pip install -e .
-      - name: Run unit tests
+      - name: Configure environment
+        run: |
+          echo "::group::pip install"
+          python -m pip install tox
+          echo "::endgroup::"
+          mkdir -p results
+      - name: Setup Tox environments
+        run: tox run --colored yes -m tests --notest
+      - name: Test with tox
+        run: tox run --skip-pkg-install --no-list-dependencies --result-json results/tox-${{ matrix.platform }}.json --colored yes -m unit-tests
+        env:
+          PYTEST_ADDOPTS: "--no-header -vv -rN"
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v3
+        with:
+          directory: ./results/
+          files: coverage*.xml
+      - name: Upload test results
+        if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-results-${{ matrix.platform }}
+          path: results/
+  integration:
+    strategy:
+      matrix:
+        platform: [ubuntu-22.04, windows-2019]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: |
+            3.10
+            3.12
+          cache: 'pip'
+      - name: Install Ubuntu-specific dependencies
+        if: ${{ startsWith(matrix.platform, 'ubuntu') }}
         run: |
-          make test-units
-      - name: Run integration tests
+          sudo apt update
+          sudo apt install -y libapt-pkg-dev
+      - name: Install Ubuntu 22.04-specific dependencies
+        if: ${{ matrix.platform == 'ubuntu-22.04' }}
         run: |
-          make test-integrations
-
+          # 22.04 is the only one that has an 'umoci' package
+          sudo apt install -y umoci
+      - name: Configure environment
+        run: |
+          echo "::group::pip install"
+          python -m pip install tox
+          echo "::endgroup::"
+          mkdir -p results
+      - name: Setup Tox environments
+        run: tox run --colored yes -m tests --notest
+      - name: Test with tox
+        run: tox run --skip-pkg-install --no-list-dependencies --result-json results/tox-${{ matrix.platform }}.json --colored yes -m integration-tests
+        env:
+          PYTEST_ADDOPTS: "--no-header -vv -rN"
+      - name: Upload test results
+        if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-results-${{ matrix.platform }}
+          path: results/

.gitignore

@@ -51,9 +51,6 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 
-# Spread tests
-.spread-reuse.yaml
-
 # Translations
 *.mo
 *.pot
@@ -73,6 +70,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/reference/commands
+docs/sphinx-starter-pack/
 
 # PyBuilder
 target/
@@ -131,27 +130,28 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-# IDE settings
-.vscode/
+
+# Caches for various tools
+/.*_cache/
+
+# Test results
+/results/
 
 # direnv
 .direnv
 .envrc
 
-# snap
-rockcraft_*.snap
+# Ignore version module generated by setuptools_scm
+/*/_version.py
 
-# rock
-*.rock
+# Visual Studio Code
+.vscode/
 
-# sphinx
+# Ignore external tools
+/tools/external/
 
-docs/warnings.txt
-docs/.sphinx/.wordlist.dic
-docs/reference/commands
-.DS_Store
-__pycache__
-.idea/
+# snap
+rockcraft_*.snap
 
-# build-generated version file
-rockcraft/_version.py
+# rock
+*.rock

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # renovate: datasource=pypi;depName=ruff
+    rev: "v0.1.6"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+  - repo: https://github.com/psf/black
+    # renovate: datasource=pypi;depName=black
+    rev: "23.11.0"
+    hooks:
+      - id: black
+  - repo: https://github.com/adrienverge/yamllint.git
+    # renovate: datasource=pypi;depName=yamllint
+    rev: "v1.33.0"
+    hooks:
+      - id: yamllint