Source control UI

nRF Connect for VS Code

tags
nRF Connect for VS Code

The Zephyr project includes a tool called west, which is used to manage the combination of multiple Git repositories and versions that make up the nRF Connect SDK. The extension provides a graphical front end to west.

The extension provides an overview of your west workspace and modules in Visual Studio Code's Source Control View, accessible from the Activity Bar.

West modules in the Source Control View

The west module source control section includes the following information and UI elements:

  • Clickable tag or description of the workspace that holds the manifest. On the image above, this is v2.8.0. Clicking this item lets you change the workspace for source control.

  • The path of the manifest file within the selected workspace repository. On the image above, this is nrf/west.yml. Clicking this item lets you change the west manifest file for the given west workspace. For example, for the v2.8.0 tag on the image above, you could choose between nrf/west.yml or zephyr/west.yml.

  • A list that includes the path and all the west modules:

    • Manifest: The path of the current west manifest.
    • Changed: Modules that are out of sync with the west manifest or have local file changes.
    • Clean: Modules that are synced and do not have local changes.
    • Not Cloned: Modules that have not been cloned and therefore do not exist in the file system. These normally correspond to excluded filter groups in the west manifest.
  • West Refresh button for triggering status update if the workspace is out of sync with the manifest. Clicking on the symbol updates the west workspace state.

    Refresh west modules button in the Source Control View

  • West Update Source Control West Workspace button for triggering the update of out-of-sync modules in the workspace. For example, those listed under Changed in the image below.

    Note

    This button is only visible when there are out-of-sync modules.

    West Update Source Control West Workspace button with out-of-sync modules in the workspace

The information about the west module status can be displayed in the Status Bar.