Merge pull request #2258 from MiczFlor/future3/develop

Release v3.6.0

Author: AlvinSchiller

.flake8

@@ -1,12 +1,16 @@
 [flake8]
 max-line-length = 127
 ignore =
+    # continuation line over-indented for hanging indent
+    E126,
     # continuation line over-indented for visual indent
     E127,
     # continuation line under-indented for visual indent
     E128,
     # line break before binary operator
-    W503
+    W503,
+    # global name / nonlocal name is unused: name is never assigned in scope
+    F824
 per-file-ignores =
     # Only in __init__files ignore imported but unused
     # Not necessary, if __all__ is declared in __init__ file

.githooks/post-merge

@@ -5,9 +5,10 @@
 # TO ACTIVATE: cp .githooks/post-merge .git/hooks/.
 #
 # Checks:
+# - Changes to system requirements
+# - Changes to python requirements
 # - Changes to Web App
 # - Changes to web dependency
-# - Changes to python requirements
 #
 # Actions are not triggered automatically as they can take some
 # time. The user is warned if an action is required.
@@ -21,7 +22,7 @@ warn_npm_dependency() {
   echo "ATTENTION: npm dependencies have changed since last pull!"
   echo ""
   echo "To update dependencies and rebuilt Web App run:"
-  echo "$ cd src/webapp && ./run_rebuild.sh -u"
+  echo " cd src/webapp && ./run_rebuild.sh -u"
   echo "************************************************************"
   echo -e "\n"
 }
@@ -32,7 +33,19 @@ warn_webapp() {
   echo "ATTENTION: Web App sources have changed since last pull!"
   echo ""
   echo "To rebuilt the Web App run:"
-  echo "$ cd src/webapp && ./run_rebuild.sh"
+  echo " cd src/webapp && ./run_rebuild.sh"
+  echo "************************************************************"
+  echo -e "\n"
+}
+
+warn_system_requirements() {
+  echo -e "\n"
+  echo "************************************************************"
+  echo "ATTENTION: System requirements have changed since last pull!"
+  echo ""
+  echo "To update system requirements on the RPi run"
+  echo " sudo apt-get -y update"
+  echo " sed 's/#.*//g' packages-core.txt | xargs sudo apt-get -y install --no-install-recommends"
   echo "************************************************************"
   echo -e "\n"
 }
@@ -43,8 +56,9 @@ warn_python_requirements() {
   echo "ATTENTION: Python requirements have changed since last pull!"
   echo ""
   echo "To update python requirements on the RPi run"
-  echo "$ source .venv/bin/activate"
-  echo "$ python -m pip install --upgrade -r requirements.txt"
+  echo " source .venv/bin/activate"
+  echo " python -m pip install --upgrade -r requirements.txt"
+  echo " python -m pip uninstall -y -r requirements-excluded.txt"
   echo "************************************************************"
   echo -e "\n"
 }
@@ -55,7 +69,7 @@ warn_githooks() {
   echo "ATTENTION: Recommended git hooks changed!"
   echo ""
   echo "To update, REVIEW and copy .githooks/* to .git/hooks"
-  echo "$ cp .githooks/* .git/hooks/."
+  echo " cp .githooks/* .git/hooks/."
   echo "************************************************************"
   echo -e "\n"
 }
@@ -65,20 +79,22 @@ warn_installer() {
   echo "************************************************************"
   echo "ATTENTION: Installer sources have changed since last pull!"
   echo ""
-  echo "Rerun the installer to apply changes"
-  echo "$ ./installation/install-jukebox.sh"
+  echo "It is NOT recommended to continue the update process."
+  echo "The installation routines have changed and"
+  echo "compatibility with the old version is not guaranteed."
   echo "************************************************************"
   echo -e "\n"
 }
 
 # files_changed="$(git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD)"
+python_req_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD requirements.txt)"
+python_excl_req_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD requirements-excluded.txt)"
 webapp_changed="$(git diff-tree -r --name-only --no-commit-id ORIG_HEAD HEAD src/webapp)"
 webapp_dep_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD src/webapp/package.json)"
-python_req_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD requirements.txt)"
 githooks_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD .githooks)"
 installer_changed="$(git diff --name-only --no-commit-id ORIG_HEAD HEAD installation)"
 
-if [[ -n $python_req_changed ]]; then
+if [[ -n $python_req_changed || -n $python_excl_req_changed ]]; then
     warn_python_requirements
 fi
 

.githooks/pre-commit

@@ -9,6 +9,9 @@
 #   Note: This only checks the modified files
 # - docs build of if any python file is staged
 #   Note: This builds the entire documentation if a changed file goes into the documentation
+# - Markdownlint if any markdown file is staged
+#   Note: This checks all markdown files as configured in .markdownlint-cli2.yaml
+
 #
 # If there are problem with this script, commit may still be done with
 # git commit --no-verify
@@ -40,6 +43,20 @@ fi
 
 code=$(( flake8_code + doc_code ))
 
+# Pass all staged markdown files through markdownlint-cli2
+MD_FILES="$(git diff --diff-filter=d --staged --name-only -- **/*.md)"
+markdownlint_code=0
+if [[ -n $MD_FILES ]]; then
+  echo -e "\n**************************************************************"
+  echo "Modified Markdown files. Running markdownlint-cli2 ... "
+  echo -e "**************************************************************\n"
+  ./run_markdownlint.sh
+  markdownlint_code=$?
+  echo "Markdownlint-cli2 return code: $markdownlint_code"
+fi
+
+code=$(( flake8_code + doc_code + markdownlint_code))
+
 if [[ code -gt 0 ]]; then
   echo -e "\n**************************************************************"
   echo -e "ERROR(s) during pre-commit checks. Aborting commit!"

.github/ISSUE_TEMPLATE/bug_template.md

@@ -33,7 +33,6 @@ Please post here the output of 'tail -n 500 /var/log/syslog' or 'journalctl -u m
 i.e. `find logfiles at https://paste.ubuntu.com/p/cRS7qM8ZmP/`
 -->
 
-
 ## Software
 
 ### Base image and version
@@ -59,7 +58,6 @@ the following command will help with that
 i.e. `scripts/installscripts/buster-install-default.sh`
 -->
 
-
 ## Hardware
 
 ### RaspberryPi version

.github/workflows/bundle_webapp_and_release_v3.yml

@@ -101,7 +101,7 @@ jobs:
           tar -czvf ${{ steps.vars.outputs.webapp_bundle_name }} build
 
       - name: Artifact Upload
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.vars.outputs.webapp_bundle_name }}
           path: ${{ steps.build-webapp.outputs.webapp-root-path }}/${{ steps.vars.outputs.webapp_bundle_name }}
@@ -119,7 +119,7 @@ jobs:
 
     steps:
       - name: Artifact Download
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ needs.build.outputs.webapp_bundle_name }}
 

.github/workflows/codeql-analysis_v3.yml

@@ -37,38 +37,20 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-          python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        # Install necessary packages
-        sudo apt-get install libasound2-dev pulseaudio
-        python3 -m venv .venv
-        source ".venv/bin/activate"
-
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        # Set the `CODEQL-PYTHON` environment variable to the Python executable
-        # that includes the dependencies
-        echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
-
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
-        setup-python-dependencies: false
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -82,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/markdown_v3.yml

@@ -0,0 +1,28 @@
+name: Markdown Linting
+
+on:
+  push:
+    branches:
+        - 'future3/**'
+    paths:
+        - '**.md'
+  pull_request:
+    branches:
+        - 'future3/**'
+    paths:
+        - '**.md'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Linting markdown
+      uses: DavidAnson/markdownlint-cli2-action@v15
+      with:
+        config: .markdownlint-cli2.yaml
+      #continue-on-error: true

.github/workflows/pythonpackage_future3.yml

@@ -5,11 +5,23 @@ on:
     branches:
         - 'future3/**'
     paths:
+        - '.github/workflows/pythonpackage_future3.yml'
+        - '.flake8'
+        - 'run_flake8.sh'
+        - '.coveragerc'
+        - 'run_pytest.sh'
+        - '**requirements*.txt'
         - '**.py'
   pull_request:
     branches:
         - 'future3/**'
     paths:
+        - '.github/workflows/pythonpackage_future3.yml'
+        - '.flake8'
+        - 'run_flake8.sh'
+        - '.coveragerc'
+        - 'run_pytest.sh'
+        - '**requirements*.txt'
         - '**.py'
 
 jobs:
@@ -19,18 +31,23 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         sudo apt-get update
         sudo apt-get install -y libasound2-dev pulseaudio
+
+        CUR_DIR="$(pwd)"
+        mkdir -p tmp && cd tmp && wget -q http://abyz.me.uk/lg/lg.zip && unzip lg.zip > /dev/null && cd lg && make && sudo make install
+        cd "${CUR_DIR}" && sudo rm -rf tmp > /dev/null
+
         python3 -m venv .venv
         source ".venv/bin/activate"
 

.github/workflows/test_docker_debian_codename_sub_v3.yml

@@ -134,11 +134,11 @@ jobs:
           BASE_TEST_IMAGE=${{ steps.vars.outputs.image_tag_name_local_base }}
 
     - name: Artifact Upload Docker Image
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: ${{ steps.vars.outputs.image_file_name }}
         path: ${{ steps.vars.outputs.image_file_path }}
-        retention-days: 1
+        retention-days: 2
 
 
   # Run tests with build image
@@ -159,7 +159,7 @@ jobs:
       uses: docker/setup-buildx-action@v3.0.0
 
     - name: Artifact Download Docker Image
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: ${{ needs.build.outputs.image_file_name }}
 
@@ -179,13 +179,14 @@ jobs:
 
   # cleanup after test execution
   cleanup:
-    # run only if tests didn't fail: keep the artifact to make job reruns possible
-    if: ${{ !failure() }}
-    needs: [build, test]
-    runs-on: ${{ inputs.runs_on }}
-
-    steps:
-        - name: Artifact Delete Docker Image
-          uses: geekyeggo/delete-artifact@v2
-          with:
-            name: ${{ needs.build.outputs.image_file_name }}
+   # run only if tests didn't fail: keep the artifact to make job reruns possible
+   if: ${{ !failure() }}
+   needs: [build, test]
+   runs-on: ${{ inputs.runs_on }}
+  
+   steps:
+       - name: Artifact Delete Docker Image
+         uses: geekyeggo/delete-artifact@v5
+         with:
+           name: ${{ needs.build.outputs.image_file_name }}
+           failOnError: false