Use platformio-core to build the matrix (#7424)

Co-authored-by: Ben Meadors <benmmeadors@gmail.com>

.github/workflows/main_matrix.yml

@@ -31,10 +31,16 @@ jobs:
       fail-fast: false
       matrix:
         arch: [esp32, esp32s3, esp32c3, esp32c6, nrf52840, rp2040, stm32, check]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - id: jsonStep
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+          cache: pip
+      - run: pip install -U platformio
+      - name: Generate matrix
+        id: jsonStep
         run: |
           if [[ "$GITHUB_HEAD_REF" == "" ]]; then
             TARGETS=$(./bin/generate_ci_matrix.py ${{matrix.arch}})

bin/generate_ci_matrix.py

@@ -2,50 +2,67 @@
 
 """Generate the CI matrix."""
 
-import configparser
 import json
-import os
 import sys
 import random
-
-rootdir = "variants/"
+import re
+from platformio.project.config import ProjectConfig
 
 options = sys.argv[1:]
 
 outlist = []
 
 if len(options) < 1:
-    print(json.dumps(outlist))
-    exit()
+  print(json.dumps(outlist))
+  exit(1)
 
-for subdir, dirs, files in os.walk(rootdir):
-    for file in files:
-        if file == "platformio.ini":
-            config = configparser.ConfigParser()
-            config.read(subdir + "/" + file)
-            for c in config.sections():
-                if c.startswith("env:"):
-                    section = config[c].name[4:]
-                    if "extends" in config[config[c].name]:
-                        if options[0] + "_base" in config[config[c].name]["extends"]:
-                            if "board_level" in config[config[c].name]:
-                                if (
-                                    config[config[c].name]["board_level"] == "extra"
-                                ) & ("extra" in options):
-                                    outlist.append(section)
-                            else:
-                                outlist.append(section)
-                        # Add the TFT variants if the base variant is selected
-                        elif section.replace("-tft", "") in outlist and config[config[c].name].get("board_level") != "extra":
-                            outlist.append(section)
-                        elif section.replace("-inkhud", "") in outlist and config[config[c].name].get("board_level") != "extra":
-                            outlist.append(section)
-                    if "board_check" in config[config[c].name]:
-                        if (config[config[c].name]["board_check"] == "true") & (
-                            "check" in options
-                        ):
-                            outlist.append(section)
-if ("quick" in options) & (len(outlist) > 3):
+cfg = ProjectConfig.get_instance()
+pio_envs = cfg.envs()
+
+# Gather all PlatformIO environments for filtering later
+all_envs = []
+for pio_env in pio_envs:
+  env_build_flags = cfg.get(f"env:{pio_env}", 'build_flags')
+  env_platform = None
+  for flag in env_build_flags:
+    # Extract the platform from the build flags
+    # Example flag: -I variants/esp32s3/heltec-v3
+    match = re.search(r"-I\s?variants/([^/]+)", flag)
+    if match:
+      env_platform = match.group(1)
+      break
+  # Intentionally fail if platform cannot be determined
+  if not env_platform:
+    print(f"Error: Could not determine platform for environment '{pio_env}'")
+    exit(1)
+  # Store env details as a dictionary, and add to 'all_envs' list
+  env = {
+    'name': pio_env,
+    'platform': env_platform,
+    'board_level': cfg.get(f"env:{pio_env}", 'board_level', default=None),
+    'board_check': bool(cfg.get(f"env:{pio_env}", 'board_check', default=False))
+  }
+  all_envs.append(env)
+
+# Filter outputs based on options
+# Check is currently mutually exclusive with other options
+if "check" in options:
+  for env in all_envs:
+    if env['board_check']:
+      outlist.append(env['name'])
+# Filter (non-check) builds by platform
+else:
+  for env in all_envs:
+    if options[0] == env['platform']:
+      # If no board level is specified, always include it
+      if not env['board_level']:
+        outlist.append(env['name'])
+      # Include `extra` boards when requested
+      elif "extra" in options and env['board_level'] == "extra":
+        outlist.append(env['name'])
+
+# Return as a JSON list
+if ("quick" in options) and (len(outlist) > 3):
     print(json.dumps(random.sample(outlist, 3)))
 else:
-    print(json.dumps(outlist))
+    print(json.dumps(outlist))