Merge pull request #1777 from Ralim/dev

Release 2.22

Author: Ralim

PULL_REQUEST_TEMPLATE.md .github/pull_request_template.mdPULL_REQUEST_TEMPLATE.md renamed to .github/pull_request_template.md

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: actions/setup-python@v4
@@ -35,6 +35,6 @@ jobs:
               mkdocs-git-revision-date-plugin mkdocs-autolinks-plugin \
               mkdocs-awesome-pages-plugin 
       - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
-      
+
       - name: Publish docs
-        run: mkdocs gh-deploy
+        run: mkdocs gh-deploy -f scripts/IronOS-mkdocs.yml -d ../site

SECURITY.md .github/security.mdSECURITY.md renamed to .github/security.md

@@ -3,13 +3,15 @@ name: CI
 on: [push, pull_request]
 
 jobs:
+
+
   build:
     runs-on: ubuntu-20.04
     container:
       image: alpine:3.16
     strategy:
       matrix:
-        model: ["TS100", "TS80", "TS80P", "Pinecil", "MHP30", "Pinecilv2"]
+        model: ["TS100", "TS80", "TS80P", "Pinecil", "MHP30", "Pinecilv2", "S60", "TS101"]
       fail-fast: true
 
     steps:
@@ -19,20 +21,21 @@ jobs:
       - name: Install dependencies (python)
         run: python3 -m pip install bdflib
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
       - name: Git ownership exception
         run: git config --global --add safe.directory /__w/IronOS/IronOS && git config --global safe.directory "$GITHUB_WORKSPACE"
 
-      - name: build ${{ matrix.model }}
+      - name: Git meta info
+        run: echo "GITHUB_CI_PR_SHA=${{github.event.pull_request.head.sha}}" >> "${GITHUB_ENV}"
+
+      - name: Build ${{ matrix.model }}
         run: cd source && ./build.sh -m ${{ matrix.model }}
 
-      - name: copy license text
-        run: |
-          cp LICENSE source/Hexfile/LICENSE
-          cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
+      - name: Copy license files
+        run: cp LICENSE scripts/LICENSE_RELEASE.md  source/Hexfile/
 
       - name: Archive ${{ matrix.model }} artifacts
         uses: actions/upload-artifact@v3
@@ -47,14 +50,15 @@ jobs:
           if-no-files-found: error
 
       - name: Generate json index file
-        run: cd source && python3 metadata.py ${{ matrix.model }}.json
+        run: ./source/metadata.py ${{ matrix.model }}.json
 
       - name: Archive ${{ matrix.model }} index file
         uses: actions/upload-artifact@v3
         with:
           name: metadata
           path: source/Hexfile/${{ matrix.model }}.json
 
+
   build_multi-lang:
     runs-on: ubuntu-20.04
     container:
@@ -70,20 +74,21 @@ jobs:
       - name: Install dependencies (python)
         run: python3 -m pip install bdflib
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
       - name: Git ownership exception
         run: git config --global --add safe.directory /__w/IronOS/IronOS && git config --global safe.directory "$GITHUB_WORKSPACE"
 
-      - name: build ${{ matrix.model }}
-        run: cd source && make -j$(nproc) model="${{ matrix.model }}" firmware-multi_compressed_European firmware-multi_compressed_Bulgarian+Russian+Serbian+Ukrainian firmware-multi_Chinese+Japanese
+      - name: Git meta info
+        run: echo "GITHUB_CI_PR_SHA=${{github.event.pull_request.head.sha}}" >> "${GITHUB_ENV}"
+
+      - name: Build ${{ matrix.model }}
+        run: make -C source/ -j$(nproc) model="${{ matrix.model }}" firmware-multi_compressed_European firmware-multi_compressed_Bulgarian+Russian+Serbian+Ukrainian firmware-multi_Chinese+Japanese
 
-      - name: copy license text
-        run: |
-          cp LICENSE source/Hexfile/LICENSE
-          cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
+      - name: Copy license files
+        run: cp LICENSE scripts/LICENSE_RELEASE.md  source/Hexfile/
 
       - name: Archive ${{ matrix.model }} artifacts
         uses: actions/upload-artifact@v3
@@ -98,75 +103,104 @@ jobs:
           if-no-files-found: error
 
       - name: Generate json index file
-        run: cd source && python3 metadata.py ${{ matrix.model }}_multi-lang.json
+        run: ./source/metadata.py ${{ matrix.model }}_multi-lang.json
 
       - name: Archive ${{ matrix.model }} index file
         uses: actions/upload-artifact@v3
         with:
           name: metadata
           path: source/Hexfile/${{ matrix.model }}_multi-lang.json
 
+
   tests:
     runs-on: ubuntu-20.04
     container:
       image: alpine:3.16
 
     steps:
-      - name: deps
+      - name: Install dependencies (apk)
         run: apk add --no-cache python3 py3-pip make git bash findutils gcc musl-dev
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: install black
+      - name: Install dependencies (python)
         run: python3 -m pip install bdflib
 
       - name: Run python tests
-        run: cd Translations && chmod +x make_translation_test.py && ./make_translation_test.py
+        run: ./Translations/make_translation_test.py
 
       - name: Run BriefLZ tests
-        run: |
-          cd source
-          make Objects/host/brieflz/libbrieflz.so
-          cd ../Translations
-          chmod +x brieflz_test.py
-          ./brieflz_test.py
-
-  check_formatting:
+        run: make  -C source/  Objects/host/brieflz/libbrieflz.so && ./Translations/brieflz_test.py
+
+
+  check_c-cpp:
+    runs-on: ubuntu-20.04
+    container:
+      image: alpine:3.16
+
+    steps:
+      - name: Install dependencies (apk)
+        run: apk add --no-cache make git diffutils findutils clang-extra-tools bash
+
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Check format style with clang-format
+        run: make  clean  check-style
+
+
+  check_python:
     runs-on: ubuntu-20.04
     container:
       image: alpine:3.16
 
     steps:
-      - name: deps
+      - name: Install dependencies (apk)
         run: apk add --no-cache python3 py3-pip make git black
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
-      - name: install black
+      - name: Install dependencies (python)
         run: python3 -m pip install bdflib flake8
 
-      - name: Check formatting with clang-format
-        run: cd source && make clean && make check-style
-
       - name: Check python formatting with black
         run: black --check Translations
 
       - name: Check python with flake8
         run: flake8 Translations
 
-  shellcheck:
-    name: runner / shellcheck
+
+  check_shell:
+    name: check_shell
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: shellcheck
         uses: reviewdog/action-shellcheck@v1
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-review # Change reporter.
           exclude: "./.git/*" # Optional.
           check_all_files_with_shebangs: "false" # Optional.
+
+
+  check_readme:
+    runs-on: ubuntu-20.04
+    container:
+      image: alpine:3.16
+
+    steps:
+      - name: Install dependencies (apk)
+        run: apk add --no-cache git
+
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Check autogenerated Documentation/README.md
+        run: /bin/sh ./scripts/deploy.sh docs_readme

.github/workflows/docs.yml

@@ -1,10 +1,13 @@
+#### Generic ####
+
 # Object files
 *.o
 *.ko
 *.obj
 *.elf
 *.d
 *.DS_Store
+
 # Precompiled Headers
 *.gch
 *.pch
@@ -31,40 +34,30 @@
 # Debug files
 *.dSYM/
 *.su
-source/.metadata/*
 
-TS100/KiCad/TS100.bak
-Logo GUI/TS100 Logo Editor/TS100 Logo Editor/obj/
-Logo GUI/TS100 Logo Editor/TS100 Logo Editor/bin/
-*.cache
-Translation Editor/.vscode/
-Translation Editor/__pycache__/
+# Custom scripts & misc. files
 *.pyc
 *.lst
 *.mk
 *.list
-source/Hexfile/
-source/Objects/
 
-ci/artefacts/
-ci/secrets/unencrypted/
+# Auto generated files
+*.cache
 codeship.aes
-.vscode/settings.json
+CoreCompileInputs.cache
 
-# Auto generated files
-source/Core/Inc/unit.h
-source/Core/Gen/
 # IDE configs
 .vs/*
 .settings/*
-..cproject.swp
+.cproject.swp
 
 # Visual Studios
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+.vscode/settings.json
 
 # Eclipse
 .metadata
@@ -120,11 +113,24 @@ local.properties
 .scala_dependencies
 .worksheet
 
-# Jetbrains
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# source code tagging systems (GNU Global, ctags, cscope)
+GPATH
+GRTAGS
+GTAGS
+*tags
+*tags/
+.*tags
+.*tags/
+cscope.*
+cscope/
+.cscope/
+
+
+#### Jetbrains: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm ####
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
+.idea/
 .idea/**/workspace.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
@@ -174,7 +180,38 @@ fabric.properties
 # Editor-based Rest Client
 .idea/httpRequests
 
-CoreCompileInputs.cache
-.vscode/settings.json
+
+#### IronOS project specific files ####
+
+# Binaries
+source/Hexfile/
+source/Objects/
+BUILDS/
+
+# Autogenerated
+source/Core/Gen/
+source/Core/Inc/unit.h
+
+# Deploy
+scripts/ci/artefacts/
+scripts/ci/secrets/unencrypted/
+
+# Generated static local docs
+site/
+
+# Translations
+Translations/__pycache__/
+Translation Editor/__pycache__/
+Translation Editor/.vscode/
+
+# misc.
 source/compile_commands.json
-.idea/
+source/.metadata/*
+
+# TS100 related
+TS100/KiCad/TS100.bak
+Logo GUI/TS100 Logo Editor/TS100 Logo Editor/obj/
+Logo GUI/TS100 Logo Editor/TS100 Logo Editor/bin/
+
+# Tests/linters/sanitizers
+source/check-style.log