Merge 4

.github/pull_request_template.md

@@ -1,15 +1,20 @@
-(Please delete any lines which don't apply)
-
-# Description of change
+<!-- Fill in a description of the change here, at least 100 characters.
+Make sure other people will be able to understand what your pull request is about.
+Delete any sections which don't apply, including the section header. -->
 
 # This change fixes the following bug(s):
+<!-- If your change fixes any bugs, list them in this section.
 
-(Please put issue URLs or #number-of-issue here.)
+Please include the issue URL or the # issue number here. -->
 
 # I have tested this change with the following hardware & software combinations:
+<!-- In this section, describe the hardware and software combinations with which you tested the PR change - operating system(s), development board name(s), ESP8266 and/or ESP32 series.
+
+If you did not perform any testing, write "NO TESTING" in this section. -->
 
-(Operating system(s), development board name(s), ESP8266 and/or ESP32.)
+# I have run the esptool.py automated integration tests with this change and the above hardware:
+<!-- In this section, post the results of running the automatic integration tests of esptool.py with this change and the above hardware.
 
-# I have run the esptool.py automated integration tests with this change and the above hardware. The results were:
+Details here: https://docs.espressif.com/projects/esptool/en/latest/contributing.html#automated-integration-tests
 
-(Details here: https://docs.espressif.com/projects/esptool/en/latest/contributing.html#automated-integration-tests)
+If you did not perform any testing, write "NO TESTING" in this section. -->

.github/workflows/build_esptool.yml

@@ -1,28 +1,27 @@
 name: Build esptool
 
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+    - '.github/**' # Ignore changes towards the .github directory
 
 jobs:
   build-esptool-binaries:
     name: Build esptool binaries for ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-latest, windows-latest]
+        os: [ubuntu-latest]
         include:
-        - os: macos-latest
-          TARGET: macos
-          SEPARATOR: ':'
         - os: ubuntu-latest
           TARGET: linux-amd64
           SEPARATOR: ':'
-        - os: windows-latest
-          TARGET: win64
-          EXTEN: .exe
-          SEPARATOR: ';'
     env:
       DISTPATH: esptool-${{ matrix.TARGET }}
-      STUBS_DIR: /esptool/targets/stub_flasher/
+      STUBS_DIR: ./esptool/targets/stub_flasher/
+      EFUSE_DIR: ./espefuse/efuse_defs/
+      PIP_EXTRA_INDEX_URL: "https://dl.espressif.com/pypi"
     steps:
       - name: Checkout repository
         uses: actions/checkout@master
@@ -35,23 +34,30 @@ jobs:
           python -m pip install --upgrade pip
           pip install pyinstaller
           pip install --user -e .
+      - name: Build stub
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          export TOOLCHAIN_DIR=$HOME/toolchain
+          export ESP8266_BINDIR=$TOOLCHAIN_DIR/xtensa-lx106-elf/bin
+          export ESP32_BINDIR=$TOOLCHAIN_DIR/xtensa-esp32-elf/bin
+          export ESP32S2_BINDIR=$TOOLCHAIN_DIR/xtensa-esp32s2-elf/bin
+          export ESP32S3_BINDIR=$TOOLCHAIN_DIR/xtensa-esp32s3-elf/bin
+          export ESP32C3_BINDIR=$TOOLCHAIN_DIR/riscv32-esp-elf/bin
+          export PATH=$PATH:$ESP8266_BINDIR:$ESP32_BINDIR:$ESP32S2_BINDIR:$ESP32S3_BINDIR:$ESP32C3_BINDIR
+          ./ci/setup_ci_build_env.sh
+          make -C flasher_stub V=1
+      - name: Archive stubs artifact
+        if: matrix.os == 'ubuntu-latest'
+        uses: actions/upload-artifact@master
+        with:
+          name: stubs
+          path: /home/runner/work/esptool/esptool/flasher_stub/build
       - name: Build with PyInstaller
         run: |
-          pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico --add-data=".${{ env.STUBS_DIR }}*.json${{ matrix.SEPARATOR }}${{ env.STUBS_DIR }}" esptool.py
-          pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico espefuse.py
+          pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico --add-data="${{ env.STUBS_DIR }}*.json${{ matrix.SEPARATOR }}${{ env.STUBS_DIR }}" esptool.py
+          pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico --add-data="${{ env.EFUSE_DIR }}*.yaml${{ matrix.SEPARATOR }}${{ env.EFUSE_DIR }}" espefuse.py
           pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico espsecure.py
           pyinstaller --distpath ./${{ env.DISTPATH }} -F --icon=ci/espressif.ico esp_rfc2217_server.py
-      - name: Sign binaries
-        if: matrix.os == 'windows-latest' && github.event_name != 'pull_request'
-        env:
-          CERTIFICATE: ${{ secrets.CERTIFICATE }}
-          CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
-        shell: pwsh
-        run: |
-          ./ci/Sign-File.ps1 -Path ./${{ env.DISTPATH }}/esptool.exe
-          ./ci/Sign-File.ps1 -Path ./${{ env.DISTPATH }}/espefuse.exe
-          ./ci/Sign-File.ps1 -Path ./${{ env.DISTPATH }}/espsecure.exe
-          ./ci/Sign-File.ps1 -Path ./${{ env.DISTPATH }}/esp_rfc2217_server.exe
       - name: Test binaries
         shell: bash
         run: |
@@ -61,13 +67,40 @@ jobs:
           ./${{ env.DISTPATH }}/esp_rfc2217_server${{ matrix.EXTEN }} -h
       - name: Add license and readme
         shell: bash
-        run: mv LICENSE README.md ./${{ env.DISTPATH }}
+        run: cp LICENSE README.md ./${{ env.DISTPATH }}
       - name: Archive artifact
         uses: actions/upload-artifact@master
         with:
           name: ${{ env.DISTPATH }}
           path: ${{ env.DISTPATH }}
 
+  push_stubs:
+    name: Commit changed files
+    needs: build-esptool-binaries
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+      - name: Download builded stubs
+        uses: actions/download-artifact@master
+        with:
+          name: stubs
+          path: ./mv_stubs
+      - name: Display structure of downloaded files
+        run: |
+          ls -R
+      - name: Move stubs in folder
+        run: |
+          rm ./esptool/targets/stub_flasher/*
+          cp -R ./mv_stubs/*.json ./esptool/targets/stub_flasher
+          ls -R ./esptool/targets/stub_flasher
+          rm -rf ./mv_stubs
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Stubs updated
+
   create_release:
     name: Create GitHub release
     if: startsWith(github.ref, 'refs/tags/')

.github/workflows/dangerjs.yml

@@ -0,0 +1,22 @@
+name: DangerJS Check
+on:
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  pull-request-style-linter:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out PR head
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - name: DangerJS pull request linter
+      uses: espressif/github-actions/danger_pr_review@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dev_release_esptool_pypi.yml

@@ -0,0 +1,42 @@
+# This workflow will upload an esptool Python package when a dev release tag (e.g. "v4.7.dev2") is pushed
+
+name: PyPI dev release
+
+on:
+  push:
+    tags:
+      - v*.*.dev*
+
+jobs:
+  build_and_upload:
+
+    runs-on: ubuntu-latest
+
+    if: startsWith(github.ref, 'refs/tags/') && contains(github.ref_name, 'dev')
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.8
+      uses: actions/setup-python@master
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install twine setuptools
+
+    - name: Create development release ${{ github.ref_name }}
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_NON_INTERACTIVE: true
+      run: |
+        DEV_VERSION=$(echo "${{ github.ref_name }}" | grep -oE 'dev[0-9]+' | sed 's/dev//')
+        python ci/patch_dev_release.py --dev-no ${DEV_VERSION} esptool/__init__.py
+        git diff
+        python -m pip download esptool==$(python setup.py -V) && echo "Version ${{ github.ref_name }} already published, skipping..." && exit 1
+
+        echo "Packaging and publishing new esptool development release: ${{ github.ref_name }}"
+        python setup.py sdist
+        tar -ztvf dist/*
+        twine upload dist/*