Merge branch 'esp8266:master' into pr-postmortem-extension

Author: DRSDavidSoft

.github/workflows/build-host.yml

@@ -17,7 +17,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - run: |
@@ -32,7 +32,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - run: |

.github/workflows/build-ide.yml

@@ -17,7 +17,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - uses: actions/cache@v4
@@ -39,7 +39,7 @@ jobs:
         lwip: ["default", "IPv6"]
         chunk: [0, 1, 2, 3, 4, 5, 6, 7]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - uses: actions/setup-python@v5
@@ -52,7 +52,6 @@ jobs:
     - name: Build Sketches
       env:
         ESP8266_ARDUINO_BUILDER: "arduino"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_LWIP: ${{ matrix.lwip }}
       run: |
         bash ./tests/build.sh 8 ${{ matrix.chunk }}
@@ -63,7 +62,7 @@ jobs:
     name: Windows
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - uses: actions/setup-python@v5
@@ -75,8 +74,6 @@ jobs:
         key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh', 'tests/build.sh') }}
     - name: Build Sketch
       env:
-        ESP8266_ARDUINO_HARDWARE: "${{ runner.temp }}/hardware"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_SKETCHES: "libraries/esp8266/examples/Blink/Blink.ino"
       run: |
         bash ./tests/build.sh
@@ -88,7 +85,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - uses: actions/setup-python@v5
@@ -100,8 +97,6 @@ jobs:
         key: ${{ runner.os }}-${{ hashFiles('package/package_esp8266com_index.template.json', 'tests/common.sh', 'tests/build.sh') }}
     - name: Build Sketch
       env:
-        ESP8266_ARDUINO_HARDWARE: "${{ runner.temp }}/hardware"
-        ESP8266_ARDUINO_IDE: "${{ runner.temp }}/arduino_ide"
         ESP8266_ARDUINO_SKETCHES: "libraries/esp8266/examples/Blink/Blink.ino"
       run: |
         bash ./tests/build.sh

.github/workflows/build-platformio.yml

@@ -18,7 +18,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - uses: actions/setup-python@v5
@@ -36,4 +36,4 @@ jobs:
         ESP8266_ARDUINO_BUILDER: "platformio"
       run: |
         pip install -U platformio
-        env ESP8266_ARDUINO_SKETCHES="$(find libraries/ -name '*.ino' | shuf -n 10 -)" bash ./tests/build.sh
+        env ESP8266_ARDUINO_SKETCHES="$(find libraries/ -name '*.ino' | grep -e libraries/esp8266/examples -e SoftwareSerial)" bash ./tests/build.sh

.github/workflows/check-autogenerated.yml

@@ -16,7 +16,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - run: |
@@ -29,7 +29,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - uses: actions/setup-python@v5
@@ -51,7 +51,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - uses: actions/setup-python@v5

.github/workflows/documentation.yml

@@ -16,13 +16,16 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Build documentation
       run: |
-        pip install --user -r doc/requirements.txt
-        bash ./tests/ci/build_docs.sh
+        pushd doc/
+        python3 -mvenv _venv
+        ./_venv/bin/pip install -r requirements.txt
+        env SPHINXBUILD=$(pwd)/_venv/bin/sphinx-build ../tests/ci/build_docs.sh
+        popd

.github/workflows/release-to-publish.yml

@@ -36,7 +36,7 @@ jobs:
     name: Update master JSON file
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
         fetch-depth: 0

.github/workflows/style-check.yml

@@ -17,7 +17,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
     - uses: actions/setup-python@v5
@@ -27,15 +27,15 @@ jobs:
       run: |
           sudo apt update
           python ./tests/test_restyle.py --quiet
-          bash ./tests/ci/style_check.sh
+          env CLANG_FORMAT="clang-format-18" bash ./tests/ci/style_check.sh
 
   # Validate orthography
 
   code-spell:
     name: codespell
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: false
     - name: Run codespell

.github/workflows/tag-to-draft-release.yml

@@ -18,7 +18,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         submodules: true
         fetch-depth: 0

.gitignore

@@ -1,24 +1,32 @@
 .DS_Store
-tools/dist/
-tools/xtensa-lx106-elf/
-tools/mkspiffs/
-tools/mklittlefs/
-tools/python3/
-package/versions/
-exclude.txt
 
-tests/hosts/lcov/
+*.orig
 
-*.pyc
 *.gch
+*.pyc
 
-boards.local.txt
-
-*.gcov
-*.gcno
 *.gcda
-*.o
+*.gcno
+*.gcov
 *.a
+*.o
+
+#created by user/scripts
+cores/esp8266/CommonHFile.h
+tests/host/lcov/
+tools/sdk/ld/backup/
+*.local.txt
+.cache
+compile_commands.json
+
+#dist
+tools/dist/
+tools/mklittlefs/
+tools/mkspiffs/
+tools/python3/
+tools/xtensa-lx106-elf/
+package/versions/
+exclude.txt
 
 #Ignore files built by Visual Studio/Visual Micro
 [Dd]ebug*/

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "doc/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Install same versions as our local tools
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: doc/requirements.txt