The build system for all (preview) target images have just been updated to reduce complexity and aid interoperability. These changes are particularly relevant for those interested in local builds and debugging of the interpreter.
Until this change, the following applied:
- The CD-CI pipeline (based on Azure Pipelines) was self-contained and completely autonomous.
- Local builds relied on developers following a recipe to download and install all the required tools. ESP32 developers where luckier than the rest as there were some PowerShell scripts that downloaded and installed some of the required tools.
The above lead to situations where developers struggled to follow the setup and configuration instructions, and became frustrated in their attempts to match between the scripts used by Azure Pipelines and the automated install scripts. Not to mention the build instructions/guides in the documentation continually falling behind.
Considering that we want to keep using the powerful Azure Pipelines (which is able to consume PowerShell scripts), the path seemed quite obvious. We should have a common base of PowerShell scripts, that are consumed by either Azure Pipelines or locally by the developer if needed.
Of course, there will still be variations on all this, mainly because the Azure Pipelines build agent already includes some pre-installed tools and the locations to download are different between the agent and a local machine where a developer has full control of where the tools should be installed. All of this can be factored into the PowerShell scripts and the various Pipelines yaml documents.
So what has changed?
Some wrapper scripts have been added to deal with differences in the required tools for the various target platforms.
New scripts were added to install ALL the required tools. This is now real (except for Visual Studio Code).
Also, a new script was added to wrap the calls to CMake providing a true “fire-and-forget” experience for those who prefer to build locally without having to worry about anything at all.
On top of this, bringing the build system a couple of notches up, there are now launch and build configurations per target living in each target folder. To make this really useful and developer friendly, a new script is now also available to fully setup VS Code. This script sets all of the required entries in settings.json, composes the launch configuration and CMake variants by grabbing the individual configurations from the various targets. And I really mean ALL because the tool paths are also updated with the setups/install from the previous step.
The build guides have been updated to reflect and describe all this, But I will summarize it here to give a concise overview.
For example, to install all the required tools to build an ESP32 image in a specific location:
.\install-nf-tools.ps1 -TargetSeries ESP32 -Path 'Z:\my-nftools'
To build an image for the STM32 F429 Discovery board:
.\build.ps1 -Target ST_STM32F429I_DISCOVERY
To setup Visual Studio Code:
Hopefully this is an important step forward in what concerns the setup stage. So, there are no more excuses to not setup a local build system and even debug it.
What are you waiting for? Go get it and have fun with .NET nanoFramework! 😉