v1.3.0

Major changes

• Added support for alias commands #716
  Alias commands can be added using the configuration west config alias.<name> "<command>"
• Changed to a pyproject.toml package format in accordance to PEP 621 #715

Other changes

• Add cache support for submodules #697
• Decode manifest files as UTF-8 by default #711
• Pass unknown arguments for west diff and west status to underlying git commands #718
• Added --manifest argument to west diff to allow comparing
  the current workspace to the manifest revisions #719 and #728
• Environment variables can be used with west forall #721
  see west help forall for details
• Added support for early argument -q to reduce verbosity #723
• Added docker compose testing infrastructure #733
• Automate Pypi releases from Github Actions #737
• Added --clone-opt argument to west init to pass to git clone #744
• Support python 3.13 and drop support for python 3.8 #752
• Prevent manifests from having projects in the .west directory #754
• Add NTFS workarounds and --rename-delay for west init #756
• Print a stack trace when calling die in debug -vvv #757

Bug fixes

• Use 'backslashreplace' not to crash on malformed UTF from subprocess #700
• Fix handling in west diff for repositories with merge conflicts #732
  Additionally improve error printing and handle git diff return codes
• Fix --freeze and --resolve for the manifest command when git submodules are used #740
• Fixed release workflow when downloading artifacts #745
• west diff --manifest now compares to manifest-rev #748

v1.3.0 Alpha4

Same as v1.3.0 Alpha3 with:

Other changes:

• Support python 3.13 and drop support for python 3.8 #752
• Prevent manifests from having projects in the .west directory #754
• Add NTFS workarounds and --rename-delay for west init #756
• Print a stack trace when calling die in debug -vvv #757

v1.3.0 Alpha3

Same as v1.3.0 Alpha2 with:

Other changes:

• Added --clone-opt argument to west init to pass to git clone #744

Bug fixes:

• west diff --manifest now compares to manifest-rev #748

v1.3.0 Alpha2

Same as v1.3.0 Alpha1 with:

Bug fixes:

• Fixed release workflow when downloading artifacts #745

v1.3.0 Alpha1

Major changes

• Added support for alias commands #716
  Alias commands can be added using the configuration west config alias.<name> "<command>"
• Changed to a pyproject.toml package format in accordance to PEP 621 #715

Other changes

• Add cache support for submodules #697
• Decode manifest files as UTF-8 by default #711
• Pass unknown arguments for west diff and west status to underlying git commands #718
• Added --manifest argument to west diff to allow comparing
  the current workspace to the manifest revisions #719 and #728
• Environment variables can be used with west forall #721
  see west help forall for details
• Added support for early argument -q to reduce verbosity #723
• Added docker compose testing infrastructure #733
• Automate Pypi releases from Github Actions #737

Bug fixes

• Use 'backslashreplace' not to crash on malformed UTF from subprocess #700
• Fix handling in west diff for repositories with merge conflicts #732
  Additionally improve error printing and handle git diff return codes
• Fix --freeze and --resolve for the manifest command when git submodules are used #740

v1.2.0

Major changes:

• New 'west grep' command for running a "grep tool" in your west workspace's
  repositories. Currently, 'git grep', 'ripgrep', and standard 'grep' are
  supported grep tools.

  To run this command to get 'git grep foo' results from all cloned,
  active repositories, run:

  west grep foo

  For more details, run 'west help grep'.

Other changes:

• The manifest file format now supports a 'description' field in each
  'projects:' element.

• 'west list --format' now accepts '{description}' in the format
  string, which prints the project's 'description:' value.

• 'west compare' now always prints information about
  the manifest-rev branch

Bug fixes:

• 'west init' aborts if the destination directory already exists.

API changes:

• 'west.commands.WestCommand' methods 'check_call()' and
  'check_output()' now take any kwargs that can be passed on
  to the underlying subprocess function.

• 'west.commands.WestCommand.run_subprocess()': new wrapper
  around 'subprocess.run()'. This could not be named 'run()'
  because 'WestCommand' already had a method by this name.

• 'west.commands.WestCommand' methods 'dbg()', 'inf()',
  'wrn()', and 'err()' now all take an 'end' kwarg, which
  is passed on to the call to 'print()'.

• 'west.manifest.Project' now has a 'description' attribute,
  which contains the parsed value of the 'description:' field
  in the manifest data.

v1.0.0

Major changes in this release:

• The APIs are now declared stable. Any breaking changes will be
  communicated by a major version bump from v1.x.y to v2.x.y.

• West v1.0 no longer works with the Zephyr v1.14 LTS releases. This LTS has
  long been obsoleted by Zephyr v2.7 LTS. If you need to use Zephyr v1.14, you
  must use west v0.14 or earlier.

• Like the rest of Zephyr, west now requires Python v3.8 or later

• West commands no longer accept abbreviated command line arguments. For
  example, you must now specify "west update --keep-descendants" instead of
  using an abbreviation like "west update --keep-d". This is part of a change
  applied to all of Zephyr's Python scripts' command-line interfaces. The
  abbreviations were causing problems in practice when commands were updated to
  add new options with similar names but different behavior to existing ones.

Other changes:

• All built-in west functions have stopped using "west.log"

• "west update": new "--submodule-init-config" option.
  See commit 9ba92b0 for details.

Bug fixes:

• West extension commands that failed to load properly sometimes dumped stack.
  This has been fixed and west now prints a sensible error message in this case.

• "west config" now fails on malformed configuration option arguments
  which lack a "." in the option name

API changes:

• The west package now contains the metadata files necessary for some static
  analyzers (such as mypy) to auto-detect its type annotations.
  See commit d9f00e2 for details.

• the deprecated "west.build" module used for Zephyr v1.14 LTS compatibility was
  removed

• the deprecated "west.cmake" module used for Zephyr v1.14 LTS compatibility was
  removed

• the "west.log" module is now deprecated. This module's uses global state,
  which can make it awkward to use it as an API which multiple different python
  modules may rely on.

• The west.commands module got some new APIs which lay groundwork
  for a future change to add a global verbosity control to a command's output,
  and work to remove global state from the "west" package's API:

  • New "west.commands.WestCommand.init()" keyword argument: "verbosity"
  • New "west.commands.WestCommand" property: "color_ui"
  • New "west.commands.WestCommand" methods, which should be used to print output
    from extension commands instead of writing directly to sys.stdout or
    sys.stderr: "inf()", "wrn()", "err()", "die()", "banner()",
    "small_banner()"
  • New "west.commands.VERBOSITY" enum

v0.14.0

For release notes, see:

https://docs.zephyrproject.org/latest/develop/west/release-notes.html#v0-14-0

v0.13.1

Bug fix:

- When calling west.manifest.Manifest.from_file() when outside of a
  workspace, west again falls back on the ZEPHYR_BASE environment
  variable to locate the workspace.

v0.13.0

New features:

    You can now associate arbitrary user data with the manifest repository itself in the manifest: self: userdata: value, like so:

    manifest:
      self:
        userdata: <any YAML value can go here>

Bug fixes:

    The path to the manifest repository reported by west could be incorrect in certain circumstances detailed in [issue #572](https://github.com/zephyrproject-rtos/west/issues/572). This has been fixed as part of a larger overhaul of path handling support in the west.manifest [API](https://docs.zephyrproject.org/latest/develop/west/west-apis.html#west-apis) module.

    The west.Manifest.ManifestProject.__repr__ return value was fixed

API changes:

    west.configuration.Configuration: new object-oriented interface to the current configuration. This reflects the system, global, and workspace-local configuration values, and allows you to read, write, and delete configuration options from any or all of these locations.

    west.commands.WestCommand:

        config: new attribute, returns a Configuration object or aborts the program if none is set. This is always usable from within extension command do_run() implementations.

        has_config: new boolean attribute, which is True if and only if reading self.config will abort the program.

    The path handling in the west.manifest package has been overhauled in a backwards-incompatible way. For more details, see commit [56cfe8d1d1](https://github.com/zephyrproject-rtos/west/commit/56cfe8d1d1f3c9b45de3e793c738acd62db52aca).

    west.manifest.Manifest.validate(): this now returns the validated data as a Python dict. This can be useful if the value passed to this function was a str, and the dict is desired.

    west.manifest.Manifest: new:

        path attributes abspath, posixpath, relative_path, yaml_path, repo_path, repo_posixpath

        userdata attribute, which contains the parsed value from manifest: self: userdata:, or is None

        from_topdir() factory method

    west.manifest.ManifestProject: new userdata attribute, which also contains the parsed value from manifest: self: userdata:, or is None

    west.manifest.ManifestImportFailed: the constructor can now take any value; this can be used to reflect failed imports from a [map](https://docs.zephyrproject.org/latest/develop/west/manifest.html#west-manifest-import-map) or other compound value.

    Deprecated configuration APIs:

    The following APIs are now deprecated in favor of using a Configuration object. Usually this will be done via self.config from a WestCommand instance, but this can be done directly by instantiating a Configuration object for other usages.

        west.configuration.config

        west.configuration.read_config

        west.configuration.update_config

        west.configuration.delete_config