Overview
The MCUXpresso SDK 24.12.00 is fully hosted on GitHub. Users are able to clone the SDK and easily keep up to date with changes. Version control transparency allows users to review commits, tags, diffs, etc.
Source Control
The MCUXpresso SDK on GitHub is composed of multiple groups of software distributed among different repositories. The MCUXpresso SDK uses the popular west manifest to specify what software is included. This method of delivering software was inspired by Zephyr.
The manifests folder contains the manifest file to initialize and update the west workspace. In the mcuxsdk folder you'll find the MCUXpresso SDK source code, examples, middleware integration and script files. Both of these folders contain a .git directory that contains information to track changes, branches, and history of the project.
Visual Studio Code: CLI
To interact with the repo within VS Code through a CLI, open a Terminal. The Terminal can be opened from the menu in the top left of the screen. Alternatively, the Terminal and other monitors are hidden in a bar at the bottom of the screen. Navigate to the bottom of the screen, use the cursor to drag the bar and reveal the Terminal.
Once in the CLI, git commands can be run to track the status of the MCUXpresso SDK repositories.
Visual Studio Code: GUI
The command line is useful for many things, however, sometimes a gui might be productive. The source control gui that VS Code provides can be accessed through the menu on the top left of the screen or in the extensions sidebar.
The source control gui in Visual Studio Code contains three sections:
- Source Control Repositories - These are the repositories that are currently visible to the workspace. Each repository contains a menu that allows the user to pull, push, navigate across branches, etc.
- Source Control - This tracks changes made by the user. Here, you will see staged changes, commits, etc.
*Note: Contribution to the MCUXpresso SDK is currently not open.
- Source Control Graph - This provides a comprehensive overview of the project. The graph shows a representation of commits and their related data. The image below shows the source control graph for the MCUXpresso SDK. Hovering over a commit will show the author, commit date, documentation messages, and the commit ID.
Viewing Changes to source
One of the main benefits of hosting the MCUXpresso SDK on GitHub is that enables better project management. Users now have access to the entire MCUXpresso SDK project history.
Navigate to the Source Control Graph view and select any entry. Doing so will open the diff view highlighting the changes across the modified files in the commit.
