Merge branch 'test/build_action' into 'master'

feat: Build executables and attach to GitHub release

Closes IDFGH-14261

See merge request espressif/esp-idf-monitor!94

Author: peterdragun

.github/workflows/build.yml

@@ -0,0 +1,105 @@
+name: Build IDF Monitor
+
+on: [push, pull_request]
+
+jobs:
+  build-idf-monitor-binaries:
+    name: Build IDF Monitor binaries for ${{ matrix.platform }}
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [windows-amd64, linux-amd64, macos-amd64, macos-arm64, linux-armv7, linux-aarch64]
+        include:
+          - platform: windows-amd64
+            runner: windows-latest
+          - platform: linux-amd64
+            runner: ubuntu-24.04
+          - platform: macos-amd64
+            runner: macos-13
+          - platform: macos-arm64
+            runner: macos-latest
+          - platform: linux-armv7
+            runner: ubuntu-latest
+          - platform: linux-aarch64
+            runner: ubuntu-24.04-arm
+    env:
+      DISTPATH: idf-monitor-${{ matrix.platform }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        # Python is not needed for Linux runners, as they are running in a container
+        if: matrix.platform != 'linux-armv7' && matrix.platform != 'linux-aarch64' && matrix.platform != 'linux-amd64'
+        with:
+          python-version: "3.13"
+          cache: pip
+      - name: Build with PyInstaller
+        uses: espressif/python-binary-action@master
+        with:
+          scripts: 'esp_idf_monitor/__main__.py'
+          script-name: 'esp_idf_monitor'
+          output-dir: ./${{ env.DISTPATH }}
+          target-platform: ${{ matrix.platform }}
+
+      - name: Add license and readme
+        shell: bash
+        run: mv LICENSE README.md ./${{ env.DISTPATH }}
+
+      - name: Archive artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.DISTPATH }}
+          path: ${{ env.DISTPATH }}
+
+  create_release:
+    name: Create GitHub release
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build-idf-monitor-binaries
+    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@v4
+        with:
+          fetch-depth: 0
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --user -e ".[dev]"
+      - name: Generate changelog
+        run: |
+          cz changelog ${{ steps.get_version.outputs.VERSION }} --file-name changelog_body.md
+          cat changelog_body.md
+      - name: Download built binaries
+        uses: actions/download-artifact@v4
+      - name: Compress and rename binaries
+        run: |
+          for dir in idf-monitor-*; do
+            if [[ "$dir" == idf-monitor-win* ]]; then
+              zip -r "idf-monitor-v${{ steps.get_version.outputs.VERSION }}-${dir#idf-monitor-}.zip" "$dir"
+            else
+              chmod -R u=rwx,g=rx,o=rx "$dir"
+              tar -cvzf "idf-monitor-v${{ steps.get_version.outputs.VERSION }}-${dir#idf-monitor-}.tar.gz" "$dir"
+            fi
+          done
+      - name: Create release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          body_path: changelog_body.md
+          name: Version ${{ steps.get_version.outputs.VERSION }}
+          draft: true
+          prerelease: false
+          files: |
+            idf-monitor-v${{ steps.get_version.outputs.VERSION }}-*.zip
+            idf-monitor-v${{ steps.get_version.outputs.VERSION }}-*.tar.gz

.github/workflows/create_gh_release.yaml

@@ -34,6 +34,7 @@
 import serial
 from serial.tools import list_ports, miniterm
 
+from esp_idf_monitor import __version__
 # Windows console stuff
 from esp_idf_monitor.base.ansi_color_converter import get_ansi_converter
 from esp_idf_monitor.base.argument_parser import get_parser
@@ -69,8 +70,6 @@
 from esp_idf_monitor.base.web_socket_client import WebSocketClient
 from esp_idf_monitor.config import Config
 
-from . import __version__
-
 key_description = miniterm.key_description
 
 
@@ -356,11 +355,12 @@ def detect_port() -> Union[str, NoReturn]:
 
 
 def main() -> None:
-    if not sys.stdin.isatty() and not os.environ.get('ESP_IDF_MONITOR_TEST'):
-        sys.exit('Error: Monitor requires standard input to be attached to TTY. Try using a different terminal.')
     parser = get_parser()
     args = parser.parse_args()
 
+    if not sys.stdin.isatty() and not os.environ.get('ESP_IDF_MONITOR_TEST'):
+        sys.exit('Error: Monitor requires standard input to be attached to TTY. Try using a different terminal.')
+
     # use EOL from argument; defaults to LF for Linux targets and CR otherwise
     args.eol = args.eol or ('LF' if args.target == 'linux' else 'CR')