[Release] Release 2.23

.github/workflows/docs.yml

@@ -1,39 +1,38 @@
-
 name: Docs
 
 # Controls when the workflow will run
 on:
   # Triggers the workflow on push or pull request
   push:
-    branches: [ dev, docs ]
+    branches: [dev, docs]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-
 # Allow one concurrent deployment
 concurrency:
   group: "pages"
   cancel-in-progress: true
 
-
 jobs:
   deploy-docs:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v4
-
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12.3'
 
       - run: |
           pip install --upgrade pip &&
           pip install mkdocs mkdocs-gen-files pymdown-extensions \
               mkdocs-git-revision-date-plugin mkdocs-autolinks-plugin \
-              mkdocs-awesome-pages-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

.github/workflows/push.yml

@@ -1,27 +1,43 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+      - dev
+      - main
 
 jobs:
-
-
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
     strategy:
       matrix:
-        model: ["TS100", "TS80", "TS80P", "Pinecil", "MHP30", "Pinecilv2", "S60", "TS101"]
+        model:
+          [
+            "TS100",
+            "TS80",
+            "TS80P",
+            "Pinecil",
+            "MHP30",
+            "Pinecilv2",
+            "S60",
+            "S60P",
+            "T55",
+            "TS101",
+          ]
       fail-fast: true
 
     steps:
       - name: Install dependencies (apk)
-        run: apk add --no-cache gcc-riscv-none-elf gcc-arm-none-eabi newlib-riscv-none-elf newlib-arm-none-eabi findutils python3 py3-pip make git bash
+        run: apk add --no-cache gcc-riscv-none-elf g++-riscv-none-elf gcc-arm-none-eabi g++-arm-none-eabi newlib-riscv-none-elf newlib-arm-none-eabi findutils python3 py3-pip make git bash
 
       - name: Install dependencies (python)
-        run: python3 -m pip install bdflib
+        run: python3 -m pip install --break-system-packages bdflib
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 
@@ -37,44 +53,38 @@ jobs:
       - name: Copy license files
         run: cp LICENSE scripts/LICENSE_RELEASE.md  source/Hexfile/
 
+      - name: Generate json index file
+        run: ./source/metadata.py ${{ matrix.model }}.json
+
       - name: Archive ${{ matrix.model }} artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.model }}
           path: |
             source/Hexfile/${{ matrix.model }}_*.hex
             source/Hexfile/${{ matrix.model }}_*.dfu
             source/Hexfile/${{ matrix.model }}_*.bin
+            source/Hexfile/${{ matrix.model }}.json
             source/Hexfile/LICENSE
             source/Hexfile/LICENSE_RELEASE.md
           if-no-files-found: error
 
-      - name: Generate json index file
-        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
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
     strategy:
       matrix:
         model: ["Pinecil", "Pinecilv2"]
       fail-fast: true
 
     steps:
       - name: Install dependencies (apk)
-        run: apk add --no-cache gcc-riscv-none-elf newlib-riscv-none-elf findutils python3 py3-pip make git bash musl-dev
+        run: apk add --no-cache gcc-riscv-none-elf g++-riscv-none-elf gcc-arm-none-eabi g++-arm-none-eabi newlib-riscv-none-elf newlib-arm-none-eabi findutils python3 py3-pip make git bash musl-dev
       - name: Install dependencies (python)
-        run: python3 -m pip install bdflib
+        run: python3 -m pip install --break-system-packages bdflib
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 
@@ -85,101 +95,120 @@ jobs:
         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
+        run: make -C source/ -j$(nproc) model="${{ matrix.model }}" firmware-multi_compressed_European firmware-multi_compressed_Belorussian+Bulgarian+Russian+Serbian+Ukrainian firmware-multi_Chinese+Japanese
 
       - name: Copy license files
         run: cp LICENSE scripts/LICENSE_RELEASE.md  source/Hexfile/
 
+      - name: Generate json index file
+        run: ./source/metadata.py ${{ matrix.model }}_multi-lang.json
+
       - name: Archive ${{ matrix.model }} artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.model }}_multi-lang
           path: |
             source/Hexfile/${{ matrix.model }}_*.hex
             source/Hexfile/${{ matrix.model }}_*.dfu
             source/Hexfile/${{ matrix.model }}_*.bin
+            source/Hexfile/${{ matrix.model }}_multi-lang.json
             source/Hexfile/LICENSE
             source/Hexfile/LICENSE_RELEASE.md
           if-no-files-found: error
 
-      - name: Generate json index file
-        run: ./source/metadata.py ${{ matrix.model }}_multi-lang.json
+  upload_metadata:
+    needs: [build, build_multi-lang]
+    runs-on: ubuntu-24.04
 
-      - name: Archive ${{ matrix.model }} index file
-        uses: actions/upload-artifact@v3
+    steps:
+      - name: Download all prebuilts
+        uses: actions/download-artifact@v5
         with:
-          name: metadata
-          path: source/Hexfile/${{ matrix.model }}_multi-lang.json
+          path: source/Hexfile/
+          merge-multiple: true
+      - run: ls -R source/Hexfile
 
+      - name: Upload JSONs in bulk as metadata
+        uses: actions/upload-artifact@v4
+        with:
+          name: metadata
+          path: source/Hexfile/*.json
+          if-no-files-found: error
 
   tests:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
 
     steps:
       - name: Install dependencies (apk)
         run: apk add --no-cache python3 py3-pip make git bash findutils gcc musl-dev
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 
       - name: Install dependencies (python)
-        run: python3 -m pip install bdflib
+        run: python3 -m pip install --break-system-packages bdflib
 
       - name: Run python tests
         run: ./Translations/make_translation_test.py
 
       - name: Run BriefLZ tests
         run: make  -C source/  Objects/host/brieflz/libbrieflz.so && ./Translations/brieflz_test.py
 
-
   check_c-cpp:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
 
     steps:
       - name: Install dependencies (apk)
         run: apk add --no-cache make git diffutils findutils clang-extra-tools bash
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 
       - name: Check format style with clang-format
         run: make  clean  check-style
 
+  check-settings-docs:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+      - name: Run the menu docs generator
+        run: python Translations/gen_menu_docs.py
+      - name: Check that Documentation/Settings.md didn't change
+        run: git diff --exit-code
 
   check_python:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
 
     steps:
       - name: Install dependencies (apk)
         run: apk add --no-cache python3 py3-pip make git black
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
 
       - name: Install dependencies (python)
-        run: python3 -m pip install bdflib flake8
+        run: python3 -m pip install --break-system-packages bdflib flake8
 
       - name: Check python formatting with black
-        run: black --check Translations
+        run: black --diff --check Translations
 
       - name: Check python with flake8
         run: flake8 Translations
 
-
   check_shell:
     name: check_shell
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: shellcheck
         uses: reviewdog/action-shellcheck@v1
         with:
@@ -188,19 +217,23 @@ jobs:
           exclude: "./.git/*" # Optional.
           check_all_files_with_shebangs: "false" # Optional.
 
-
-  check_readme:
-    runs-on: ubuntu-20.04
+  check_docs:
+    runs-on: ubuntu-24.04
     container:
-      image: alpine:3.16
+      image: alpine:3.21
 
     steps:
       - name: Install dependencies (apk)
-        run: apk add --no-cache git
+        run: apk add --no-cache git bash grep
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           submodules: true
+          fetch-tags: true
+          fetch-depth: 0
+
+      - name: Git ownership exception
+        run: git config --global --add safe.directory /__w/IronOS/IronOS && git config --global safe.directory "$GITHUB_WORKSPACE"
 
-      - name: Check autogenerated Documentation/README.md
-        run: /bin/sh ./scripts/deploy.sh docs_readme
+      - name: Check and verify documentation
+        run: ./scripts/deploy.sh docs

.gitignore

@@ -215,3 +215,4 @@ Logo GUI/TS100 Logo Editor/TS100 Logo Editor/bin/
 
 # Tests/linters/sanitizers
 source/check-style.log
+.ash_history