add pyinstaller CI workflows

Author: TeoMahnic

.github/workflows/pyinstaller_builds.yaml

@@ -0,0 +1,62 @@
+name: PyInstaller Release Builds
+
+on:
+  #push:
+  #  branches: [ main, develop ]
+  workflow_dispatch:
+
+jobs:
+  pyinstaller_build:
+    name: Build for ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest, ubuntu-24.04-arm]
+        include:
+          - os: windows-latest
+            artifact_name: pyocd-windows
+          - os: ubuntu-latest
+            artifact_name: pyocd-linux
+          - os: macos-latest
+            artifact_name: pyocd-macos
+          - os: ubuntu-24.04-arm
+            artifact_name: pyocd-linux-arm64
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install package
+        run: pip install .
+
+      - name: Setup build environment
+        id: setup
+        run: python get_site-packages.py
+
+      - name: Verify environment
+        run: |
+          echo "Site packages: ${{ env.SITE_PACKAGES }}"
+          python -c "import sys; print(sys.version)"
+
+      - name: Build with PyInstaller
+        run: |
+          pip install pyinstaller
+          pyinstaller pyocd.spec --log-level=ERROR --clean
+
+      - name: Test binary
+        run: ./dist/pyocd/pyocd --help
+        if: success()
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: success()
+        with:
+          name: pyocd-${{ matrix.os }}
+          path: dist/pyocd/*
+          retention-days: 7

.github/workflows/pyinstaller_release.yaml

@@ -0,0 +1,27 @@
+name: Create Release 
+
+on:
+  release:
+    types: [prereleased]
+    branch: cbuild-run-dev
+
+jobs:
+  trigger-reusable:
+    uses: your-org/your-repo/.github/workflows/reusable-workflow.yml@${{github.ref_name}}
+    with:
+      example-input: "test"
+      version: ${{ github.event.release.tag_name }}
+    secrets:
+      ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+
+  retrieve-artifacts:
+    needs: trigger-reusable
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: pyocd-artifact
+            
+      - name: List files
+        run: ls -l

.gitignore

@@ -30,6 +30,7 @@ lib
 lib64
 __pycache__
 *.spec
+!pyocd.spec
 
 # Installer logs
 pip-log.txt

build.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+pip3 install .
+python3 get_site-packages.py
+
+rm -R build
+rm -R dist
+
+#export value returned from get_site-packages.py
+export $(python3 get_site-packages.py)
+
+pyinstaller pyocd.spec --log-level=ERROR --clean
+
+./dist/pyocd/pyocd list --version

get_site-packages.py

@@ -0,0 +1,29 @@
+import subprocess
+import sys
+import re
+import os
+
+def get_site_packages():
+    result = subprocess.run([sys.executable, '-m', 'site'], 
+                          capture_output=True, 
+                          text=True)
+    
+    paths = result.stdout.split('\n')
+    for line in paths:
+        if 'site-packages' in line:
+            match = re.search(r"'([^']*site-packages)'", line)
+            if match:
+                return match.group(1)
+    
+    raise RuntimeError("Could not find site-packages directory")
+
+if __name__ == "__main__":
+    site_packages = get_site_packages()
+    
+    # Check if running in GitHub Actions
+    github_env = os.getenv('GITHUB_ENV')
+    if github_env:
+        with open(github_env, "a") as env_file:
+            env_file.write(f"SITE_PACKAGES={site_packages}\n")
+    else:
+        print(f"SITE_PACKAGES={site_packages}")

pyocd.py

@@ -0,0 +1,4 @@
+from pyocd.__main__ import main
+
+if __name__ == '__main__':
+    main()

pyocd.spec

@@ -0,0 +1,61 @@
+# --- Imports ---
+import os
+import sys
+from PyInstaller.utils.hooks import get_package_paths, collect_entry_point, collect_dynamic_libs
+
+# --- Configuration ---
+SITE_PACKAGES = os.getenv('SITE_PACKAGES', '')
+APP_NAME = 'pyocd'
+DEBUG = False
+
+# --- Entry Points ---
+datas_probe, hiddenimports_probe = collect_entry_point('pyocd.probe')
+datas_rtos, hiddenimports_rtos = collect_entry_point('pyocd.rtos')
+
+# --- Data Files ---
+datas = [
+    (get_package_paths('pyocd')[1], 'pyocd'),
+    (get_package_paths('pylink')[1], 'pylink'),
+    ('pyocd/debug/sequences/sequences.lark', 'pyocd/debug/sequences'),
+    ('pyocd/debug/svd/svd_data.zip', 'pyocd/debug/svd')
+]
+datas.append((get_package_paths('cmsis_pack_manager')[1], 'cmsis_pack_manager'))
+
+# --- Analysis Configuration ---
+a = Analysis(
+    ['pyocd.py'],
+    pathex=[],
+    binaries=collect_dynamic_libs('cmsis_pack_manager') + collect_dynamic_libs('libusb_package'),
+    datas=datas + datas_probe + datas_rtos,
+    hiddenimports=hiddenimports_probe + hiddenimports_rtos,
+    excludes=['tkinter'],
+    runtime_hooks=[],
+    cipher=None,
+    noarchive=False
+)
+
+# --- Build Components ---
+pyz = PYZ(a.pure, a.zipped_data)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    [],  # Empty list for directory build
+    exclude_binaries=True,
+    name=APP_NAME,
+    debug=DEBUG,
+    strip=False,
+    upx=True,
+    console=True
+)
+
+# --- Output Collection ---
+coll = COLLECT(
+    exe,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    strip=False,
+    upx=True,
+    name=APP_NAME
+)

pyocd_logo.png

@@ -0,0 +1 @@
+cmsis-pack-manager