circuitpython/tools/ci_set_matrix.py

#! /usr/bin/env python3

# SPDX-FileCopyrightText: 2021 Scott Shawcroft
# SPDX-FileCopyrightText: 2021 microDev
#
# SPDX-License-Identifier: MIT

"""
This script is used in GitHub Actions to determine what docs/boards are
built based on what files were changed. The base commit varies depending
on the event that triggered run. Pull request runs will compare to the
base branch while pushes will compare to the current ref. We override this
for the adafruit/circuitpython repo so we build all docs/boards for pushes.

"""

import re
import os
import sys
import json
import yaml

import build_board_info

PORT_TO_ARCH = {
    "atmel-samd": "arm",
    "cxd56": "arm",
    "espressif": "espressif",
    "litex": "riscv",
    "mimxrt10xx": "arm",
    "nrf": "arm",
    "raspberrypi": "arm",
    "stm": "arm",
}

changed_files = json.loads(os.environ["CHANGED_FILES"])
print("changed_files")
print(changed_files)


def set_boards_to_build(build_all):
    # Get boards in json format
    boards_info_json = build_board_info.get_board_mapping()
    all_board_ids = set()
    port_to_boards = {}
    board_to_port = {}
    for board_id in boards_info_json:
        info = boards_info_json[board_id]
        if info.get("alias", False):
            continue
        all_board_ids.add(board_id)
        port = info["port"]
        if port not in port_to_boards:
            port_to_boards[port] = set()
        port_to_boards[port].add(board_id)
        board_to_port[board_id] = port

    boards_to_build = all_board_ids

    if not build_all:
        boards_to_build = set()
        board_pattern = re.compile(r"ports\/\w+\/boards\/(\w+)\/")
        port_pattern = re.compile(r"ports\/(\w+)\/")
        for p in changed_files:
            # See if it is board specific
            board_matches = board_pattern.search(p)
            if board_matches:
                board = board_matches.group(1)
                boards_to_build.add(board)
                continue

            # See if it is port specific
            port_matches = port_pattern.search(p)
            if port_matches:
                port = port_matches.group(1)
                boards_to_build.update(port_to_boards[port])
                continue

            # Otherwise build it all
            boards_to_build = all_board_ids
            break

    # Split boards by architecture.
    print("Building boards:")
    arch_to_boards = {"arm": [], "riscv": [], "espressif": []}
    for board in boards_to_build:
        print(" ", board)
        arch = PORT_TO_ARCH[board_to_port[board]]
        arch_to_boards[arch].append(board)

    # Set the step outputs for each architecture
    for arch in arch_to_boards:
        print("::set-output name=" + arch + "-boards::" + json.dumps(sorted(arch_to_boards[arch])))


def set_docs_to_build(build_all):
    doc_match = build_all
    if not build_all:
        doc_pattern = re.compile(
            r"extmod\/ulab\/code|ports\/\w+\/bindings|shared-bindings|\.(?:md|MD|rst|RST)$"
        )
        for p in changed_files:
            if doc_pattern.search(p):
                doc_match = True
                break

    # Set the step outputs
    print("Building docs:", doc_match)
    print("::set-output name=docs-build::" + str(doc_match))


def check_changed_files():
    if not changed_files or (
        os.environ.get("GITHUB_EVENT_NAME", "") == "push"
        and os.environ.get("GITHUB_REPOSITORY", "") == "adafruit/circuitpython"
    ):
        print("Building all docs/boards because of adafruit/circuitpython branch")
        return True
    else:
        print("Adding docs/boards to build based on changed files")
        return False


def main():
    build_all = check_changed_files()
    set_docs_to_build(build_all)
    set_boards_to_build(build_all)


if __name__ == "__main__":
    main()