Adding SDK Recursive Build Tool

[IvanRuzavin]

Automated MCU Setup Building Tool with mikroSDK Support in NECTOStudio

Overview

This tool automates recursive setup builds for all MCUs, MCU cards, and Boards affected by changes to mikroSDK files. It ensures changes don't cause build failures, allowing safe merging to the master branch and live release.

Workflow Steps

1. Prepare Your Branch

• Ensure your branch is up-to-date and all changes are pushed.

2. Draft a New Release

• Go to mikrosdk_v2 Releases and draft a new release.
• Set the target branch and create a new tag and release name (naming logic to be discussed).
• Mark as pre-release and publish.

3. Update Release

• Wait for the Release Asset Upload workflow to finish.
• Edit the release and set it as the latest release instead of pre-release.

4. Index Latest Release

• Go to actions, choose the "Index Latest Release" action, and run the workflow on the master branch with "Test" indexing.

5. If Adding MCU Card/Board

• Update necto_db.db in your branch in the core_packages repo.
• Repeat the release and indexing steps for the core_packages repo.

6. Run SDK Recursive Build

• It should be triggered the moment you create a PR to main branch
• If you want to trigger it manually, go to actions, choose "SDK Recursive Build," and run the workflow on your branch for changed files.

Results

• The setup build results are printed during the "Run Recursive Build" job.
• Artifacts (test-results archive) are available after job completion.

Detailed Workflow

1. Dependency Installation

• Install all necessary dependencies and NECTO dev/live build to download indexed Test releases.

2. File Changes Detection

• Fetch differences between the latest Test release and the previous Live release.
• Classify changes by affected files: Boards (bsp/board/include/boards), MCU Cards (bsp/board/include/mcu_cards), MCUs (target), or general SDK files (other folders).

3. Classification Logic

• Boards: Extract _MSDK_BOARD_NAME_ from board.cmake for SQL queries.
• MCU Cards: Use folder name for SQL queries.
• MCUs:
  • CMake: Extract regex for variables containing "MCU_".
  • Source Files: Search for nearest CMake and extract regex.
  • Header Files:
    • Common headers: Extract MCU name from folder structure.
    • Implementation headers: Check corresponding source folder’s CMake for usage.

4. Data Retrieval via SQL Queries

• Fetch data for building using board names, card names, and MCU regexes.
• If no data, retrieve all supported Boards, MCU Cards, and MCUs for the latest SDK.
• Store unfound data as unused.

5. Build Execution

• Determine necessary compilers and run SDK builds:
  • MCUs: Build with GENERIC Board.
  • MCU Cards: Build with all boards.
  • Boards: Build with all MCU cards.
• Fail the job if any build fails.

6. Artifacts Collection

• Collect and store JSON data with changes and build logs for any failed builds.

Additional Option

• Build All: Option to disregard changes and run builds for everything, ensuring comprehensive verification.
• Option to choose either Live or Dev NECTOStudio build for the workflow.

[StrahinjaJacimovic]

Change the workflow so that NECTO is installed after checking for changed files.

In other words install it only if there is a need to run the automated builds.

I assume you will need to split the recursive_build into two scripts.

[StrahinjaJacimovic]

Use pythons os.sep(), so there is no need to correct this for defferent OS'es

[StrahinjaJacimovic]

Add the option to skip the build entirely. Maybe a script parameter which checks a commit message variable or branch name.

[StrahinjaJacimovic]

Moved to other repository.