change(github): Add CI checks and release process

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+ignore-words-list = bloc,ser,dout,exten
+write-changes = false

.cz.toml

@@ -0,0 +1,21 @@
+[tool.commitizen]
+version = "0.0.0"
+update_changelog_on_bump = true
+tag_format = "v$version"
+changelog_start_rev = "v0.0"
+changelog_merge_prerelease = true
+annotated_tag = true
+bump_message = "change: Update version to $new_version"
+change_type_order = [
+    "BREAKING CHANGE",
+    "New Features",
+    "Bug Fixes",
+    "Code Refactoring",
+    "Performance Improvements"
+]
+
+[tool.commitizen.change_type_map]
+feat = "New Features"
+fix = "Bug Fixes"
+refactor = "Code Refactoring"
+perf = "Performance Improvements"

.github/workflows/build_and_release.yml

@@ -0,0 +1,76 @@
+name: Build and release
+
+on: [push]
+
+jobs:
+  build_stubs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout ref commit
+      uses: actions/checkout@master
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install esptool
+
+    - name: Build stub
+      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: Upload stub JSONs
+      uses: actions/upload-artifact@v4
+      with:
+        path: flasher_stub/build/esp*.json
+        if-no-files-found: error
+        retention-days: 3
+
+  create_release:
+    name: Create GitHub release
+    needs: build_stubs
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Get version
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+        shell: bash
+      - name: Checkout
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --user commitizen
+      - name: Generate changelog
+        run: |
+          cz changelog ${{ steps.get_version.outputs.VERSION }} --template ci/gh_changelog_template.md.j2 --file-name changelog_body.md
+          cat changelog_body.md
+      - name: Download stub JSONs
+        uses: actions/download-artifact@v4
+      - name: Create release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          body_path: changelog_body.md
+          name: Version ${{ steps.get_version.outputs.VERSION }}
+          draft: true
+          prerelease: false
+          files: esp*.json

.github/workflows/checks.yml

@@ -0,0 +1,21 @@
+name: pre-commit checks
+
+on: [push]
+
+jobs:
+  pre_commit_checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@master
+        with:
+          python-version: 3.12
+
+      - name: Run pre-commit hooks
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files

.github/workflows/dangerjs.yml

@@ -0,0 +1,23 @@
+name: DangerJS Pull Request linter
+
+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@v4
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - name: DangerJS pull request linter
+      uses: espressif/shared-github-dangerjs@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+flasher_stub/build/

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+    - id: codespell
+  - repo: https://github.com/espressif/conventional-precommit-linter
+    rev: v1.4.0
+    hooks:
+      - id: conventional-precommit-linter
+        stages: [commit-msg]
+default_stages: [commit]
+default_install_hook_types: [pre-commit, commit-msg]

README.md

@@ -1,6 +1,12 @@
 # esptool-legacy-flasher-stub
 
-This project is based on the original flasher stub of [esptool](https://github.com/espressif/esptool). It will be deprecated in the near future. It is not advised to base projects on it because it won't receive official support from Espressif Systems. The new and supported flasher stub will the [esp-flasher-stub](https://github.com/esp-rs/esp-flasher-stub) project.
+This project is based on the original flasher stub of [esptool](https://github.com/espressif/esptool). It will be deprecated in the near future. It is not advised to base projects on it because it won't receive official support from Espressif Systems. The new and supported flasher stub will be the [esp-flasher-stub](https://github.com/esp-rs/esp-flasher-stub) project.
+
+# How To Use
+
+1. Install esptool in [development mode](https://docs.espressif.com/projects/esptool/en/latest/esp32/contributing.html#development-setup).
+2. Obtain the flasher stub binaries as JSON files either from the [releases page](https://github.com/espressif/esptool-legacy-flasher-stub/releases) or from the artifacts of your pull request.
+3. Replace the esptool's JSONs files in the `esptool/targets/stub_flasher` directory with the obtained JSON files.
 
 ## Issue Tracker
 
@@ -10,6 +16,15 @@ Please report issues in [the esptool repository](https://github.com/espressif/es
 
 This flasher stub was initially part of the [esptool](https://github.com/espressif/esptool) project.
 
+## Contributing
+
+Please install the pre-commit hooks to ensure that your commits are properly formatted:
+
+```bash
+$ python -m pip install pre-commit
+$ pre-commit install -t pre-commit -t commit-msg
+```
+
 ## License
 
 This document and the attached source code are released as Free Software under GNU General Public License Version 2 or later. See the accompanying [LICENSE file](https://github.com/espressif/esptool-legacy-flasher-stub/blob/master/LICENSE) for a copy.

ci/gh_changelog_template.md.j2

@@ -0,0 +1,28 @@
+{# This changelog template is used for automatically generated GH release notes. #}
+{# It is passed to commitizen's --template option in a GH Actions workflow run. #}
+
+{% for entry in tree %}
+
+{% for change_key, changes in entry.changes.items() %}
+
+{% if change_key %}
+### {{ change_key }}
+{% endif %}
+
+{% for change in changes %}
+{% if change.scope %}
+- **{{ change.scope }}**: {{ change.message }}
+{% elif change.message %}
+- {{ change.message }}
+{% endif %}
+{% endfor %}
+{% endfor %}
+{% endfor %}
+
+Thanks to <FILL OUT CONTRIBUTORS>, and others for contributing to this release!
+
+# Results of checking the release against common anti-virus SW
+
+<Upload the release binaries to VirusTotal and ADD a link to the report here>
+
+The failures are probably false positives. You can mark esptool as safe in your anti-virus SW, or [install esptool from source](https://docs.espressif.com/projects/esptool/en/latest/installation.html).

ci/setup_ci_build_env.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+set -exuo pipefail
+
+ESP8266_TOOLCHAIN_URL="https://dl.espressif.com/dl/xtensa-lx106-elf-linux64-1.22.0-92-g8facf4c-5.2.0.tar.gz"
+ESP32_TOOLCHAIN_URL="https://github.com/espressif/crosstool-NG/releases/download/esp-2022r1/xtensa-esp32-elf-gcc11_2_0-esp-2022r1-linux-amd64.tar.xz"
+ESP32S2_TOOLCHAIN_URL="https://github.com/espressif/crosstool-NG/releases/download/esp-2022r1/xtensa-esp32s2-elf-gcc11_2_0-esp-2022r1-linux-amd64.tar.xz"
+ESP32S3_TOOLCHAIN_URL="https://github.com/espressif/crosstool-NG/releases/download/esp-2022r1/xtensa-esp32s3-elf-gcc11_2_0-esp-2022r1-linux-amd64.tar.xz"
+ESP32C3_TOOLCHAIN_URL="https://github.com/espressif/crosstool-NG/releases/download/esp-2022r1/riscv32-esp-elf-gcc11_2_0-esp-2022r1-linux-amd64.tar.xz"
+
+# Setup shell script to download & configure ESP8266 & ESP32 toolchains
+# for building the flasher stub program
+
+mkdir -p ${TOOLCHAIN_DIR}
+cd ${TOOLCHAIN_DIR}
+
+if ! [ -d ${ESP8266_BINDIR} ]; then
+    wget --continue --no-verbose "${ESP8266_TOOLCHAIN_URL}"
+    tar zxf $(basename ${ESP8266_TOOLCHAIN_URL})
+fi
+
+if ! [ -d ${ESP32_BINDIR} ]; then
+    # gitlab CI image may already have this file
+    wget --continue --no-verbose "${ESP32_TOOLCHAIN_URL}"
+    tar Jxf $(basename ${ESP32_TOOLCHAIN_URL})
+fi
+
+if ! [ -d ${ESP32S2_BINDIR} ]; then
+    # gitlab CI image may already have this file
+    wget --continue --no-verbose "${ESP32S2_TOOLCHAIN_URL}"
+    tar Jxf $(basename ${ESP32S2_TOOLCHAIN_URL})
+fi
+
+if ! [ -d ${ESP32S3_BINDIR} ]; then
+    # gitlab CI image may already have this file
+    wget --continue --no-verbose "${ESP32S3_TOOLCHAIN_URL}"
+    tar Jxf $(basename ${ESP32S3_TOOLCHAIN_URL})
+fi
+
+if ! [ -d ${ESP32C3_BINDIR} ]; then
+    # gitlab CI image may already have this file
+    wget --continue --no-verbose "${ESP32C3_TOOLCHAIN_URL}"
+    tar Jxf $(basename ${ESP32C3_TOOLCHAIN_URL})
+fi

flasher_stub/Makefile

@@ -50,27 +50,27 @@ ifneq ("$(V)","1")
 Q = @
 endif
 
-STUB = stub_flasher
+STUB = esp
 SRCS = stub_flasher.c slip.c stub_commands.c stub_write_flash.c stub_io.c
 SRCS_8266 = miniz.c
 
 BUILD_DIR = build
-ESPTOOL_STUBS_DIR = ../esptool/targets/stub_flasher
-
-STUB_ELF_8266 = $(BUILD_DIR)/$(STUB)_8266.elf
-STUB_ELF_32 = $(BUILD_DIR)/$(STUB)_32.elf
-STUB_ELF_32S2 = $(BUILD_DIR)/$(STUB)_32s2.elf
-STUB_ELF_32S3_BETA_2 = $(BUILD_DIR)/$(STUB)_32s3beta2.elf
-STUB_ELF_32S3 = $(BUILD_DIR)/$(STUB)_32s3.elf
-STUB_ELF_32C3 = $(BUILD_DIR)/$(STUB)_32c3.elf
-STUB_ELF_32C6BETA = $(BUILD_DIR)/$(STUB)_32c6beta.elf
-STUB_ELF_32H2_BETA_1 = $(BUILD_DIR)/$(STUB)_32h2beta1.elf
-STUB_ELF_32H2_BETA_2 = $(BUILD_DIR)/$(STUB)_32h2beta2.elf
-STUB_ELF_32C2 = $(BUILD_DIR)/$(STUB)_32c2.elf
-STUB_ELF_32C6 = $(BUILD_DIR)/$(STUB)_32c6.elf
-STUB_ELF_32C5_BETA_3 = $(BUILD_DIR)/$(STUB)_32c5beta3.elf
-STUB_ELF_32H2 = $(BUILD_DIR)/$(STUB)_32h2.elf
-STUB_ELF_32P4 = $(BUILD_DIR)/$(STUB)_32p4.elf
+ESPTOOL_STUBS_DIR = ..
+
+STUB_ELF_8266 = $(BUILD_DIR)/$(STUB)8266.elf
+STUB_ELF_32 = $(BUILD_DIR)/$(STUB)32.elf
+STUB_ELF_32S2 = $(BUILD_DIR)/$(STUB)32s2.elf
+STUB_ELF_32S3_BETA_2 = $(BUILD_DIR)/$(STUB)32s3beta2.elf
+STUB_ELF_32S3 = $(BUILD_DIR)/$(STUB)32s3.elf
+STUB_ELF_32C3 = $(BUILD_DIR)/$(STUB)32c3.elf
+STUB_ELF_32C6BETA = $(BUILD_DIR)/$(STUB)32c6beta.elf
+STUB_ELF_32H2_BETA_1 = $(BUILD_DIR)/$(STUB)32h2beta1.elf
+STUB_ELF_32H2_BETA_2 = $(BUILD_DIR)/$(STUB)32h2beta2.elf
+STUB_ELF_32C2 = $(BUILD_DIR)/$(STUB)32c2.elf
+STUB_ELF_32C6 = $(BUILD_DIR)/$(STUB)32c6.elf
+STUB_ELF_32C5_BETA_3 = $(BUILD_DIR)/$(STUB)32c5beta3.elf
+STUB_ELF_32H2 = $(BUILD_DIR)/$(STUB)32h2.elf
+STUB_ELF_32P4 = $(BUILD_DIR)/$(STUB)32p4.elf
 
 STUBS_ELF =
 ifneq ($(WITHOUT_ESP8266),1)