Merge pull request #37 from orgua/dev

Dev

.bumpversion.cfg

@@ -1,8 +1,10 @@
 [bumpversion]
-current_version = 0.7.0
+current_version = 0.7.1
 commit = False
 tag = False
 
+# example: bump2version patch --allow-dirty
+
 [bumpversion:file:software/kernel-module/src/module_base.c]
 
 [bumpversion:file:software/python-package/shepherd_sheep/__init__.py]

.github/workflows/publish_herd.yml

@@ -22,8 +22,8 @@ jobs:
   deploy:
 
     runs-on: ubuntu-latest
-#    needs:
-#      - run-quality-assurance
+    needs:
+      - run-quality-assurance
     env:
       herd_path: "./software/shepherd-herd"
 

.github/workflows/qa_tests.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-22.04 # TODO: -latest was 20.04 and had old packages
     strategy:
       matrix:
-        python-version: ["3.11", "3.10", "3.9"]
+        python-version: ["3.12", "3.11", "3.10"]
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
@@ -46,7 +46,7 @@ jobs:
         # needs sudo because it installs packages
       - name: PyLint the shepherd py-package 🐏
         run: "pylint $(git ls-files '*.py') || pylint-exit $?"
-        # -E --py-version 3.8
+        # -E --py-version 3.10
         working-directory: "software/python-package/"
 
       - name: Install the shepherd-herd py-package 𓋿 𓀍

.github/workflows/sphinx_to_pages.yml

@@ -4,17 +4,15 @@ name: Generate Docs
 on:
   push:
     branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
   workflow_call:
 
 jobs:
   run-quality-assurance:
     uses: ./.github/workflows/qa_tests.yml
   build-pages:
     runs-on: ubuntu-latest
-#    needs:
-#  - run-quality-assurance
+    needs:
+      - run-quality-assurance
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

.gitmodules

@@ -1,11 +1,17 @@
-[submodule "datalib"]
+[submodule "software/shepherd-datalib"]
 	path = software/shepherd-datalib
 	url = https://github.com/orgua/shepherd-datalib.git
 
-[submodule "webservice"]
+[submodule "software/shepherd-webservice"]
 	path = software/shepherd-webservice
 	url = https://github.com/orgua/shepherd_webservice.git
 
-[submodule "targets"]
+[submodule "software/shepherd-targets"]
 	path = software/shepherd-targets
 	url = https://github.com/orgua/shepherd-targets.git
+
+# helpful commands:
+# git submodule add <link> <rel-path>
+# git submodule update --init --recursive
+# git submodule update --recursive --remote
+# git submodule foreach git reset --hard

.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
         args: ["--disable", "MD013"] # ignore line length
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.14
+    rev: v0.15
     hooks:
       - id: validate-pyproject
         # files: "./software/python-package/pyproject.toml"
@@ -43,7 +43,7 @@ repos:
       - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 23.10.0
     hooks:
       - id: black
 
@@ -62,7 +62,7 @@ repos:
     rev: v3.15.0
     hooks:
       - id: pyupgrade
-        args: ["--py38-plus", "--keep-runtime-typing"]
+        args: ["--py310-plus", "--keep-runtime-typing"]
 
   - repo: https://github.com/pycqa/flake8
     rev: 6.1.0
@@ -80,7 +80,6 @@ repos:
           - flake8-comprehensions
           - flake8-simplify
           - flake8-eradicate
-          - flake8-commas
 
           ### Limitations
           - flake8-blind-except
@@ -95,11 +94,21 @@ repos:
           ### Test-Improvements
           - flake8-assertive
 
-  - repo: https://github.com/ansible-community/ansible-lint.git
-    rev: v6.20.3
+          ### Load Config from ...
+          - flake8-pyproject
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.1.1'
     hooks:
-      - id: ansible-lint
-        #files: \.(yaml|yml)$
+      - id: ruff
+        # manual run: ruff check . --preview
+
+# TODO: disable, until bug is resolved, maybe connected to
+# https://github.com/ansible/ansible-lint/issues/3636
+#  - repo: https://github.com/ansible-community/ansible-lint.git
+#    rev: v6.20.3
+#    hooks:
+#      - id: ansible-lint
 
 #  - repo: https://github.com/rstcheck/rstcheck
 #    rev: v6.1.2
@@ -112,6 +121,7 @@ repos:
     rev: v2.2.6
     hooks:
       - id: codespell
+        additional_dependencies: ["tomli"]  # for py<3.11
         exclude: \.(sch|brd|lbr)$
 
 #  - repo: https://github.com/amperser/proselint
@@ -121,7 +131,7 @@ repos:
 #        types_or: ["markdown", "rst"]
 
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v16.0.6
+    rev: v17.0.3
     hooks:
       - id: clang-format
         types_or: [c++, c]
@@ -175,4 +185,4 @@ repos:
 #        args: ["--fix", "--exit-non-zero-on-fix"]
 
 # default_language_version:
-#    python: python3.8
+#    python: python3.10

Pipfile

@@ -13,6 +13,8 @@ build = "*"
 coverage = "*"
 pyright = "*"
 pandas-stubs = "*"  # for pyright
+ruff = "*"
+types-PyYAML = "*"
 
 [packages]
 # NOTE: pip fails installing these packages as editable (-e), but pipenv needs it