manifest: Support --active-only argument for --resolve/--freeze

[pdgendt]

EDIT: The discussions in #491 and #667 made it clear that --freeze and --resolve should not have their behavior changed.

Updated the PR to introduce --active-only for --resolve/--freeze.

Running west manifest --freeze expects projects to be cloned, but the purpose of inactive projects is to not clone these explicitly.

Currently it's not possible to call west manifest --freeze on a clean zephyr installment because of the optional projects.

[EricNRS]

Thank you @pdgendt. This fixes both of the issues I was seeing where:

1. west manifest --freeze would throw an exception on the first uncloned repo which was canopennode in my case
2. west manifest --resolve would include repos that were not cloned in the list

Error before pulling in the change:

$ west manifest --freeze
. . .
RuntimeError: cannot freeze; project canopennode is uncloned

With this change, both are correctly reporting cloned repos without any errors. Discussion in
https://discord.com/channels/720317445772017664/733037524498382881/1362257185597554808

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.06%. Comparing base (07aa937) to head (9b8107d).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #808      +/-   ##
==========================================
+ Coverage   83.99%   84.06%   +0.07%     
==========================================
  Files          11       11              
  Lines        3342     3345       +3     
==========================================
+ Hits         2807     2812       +5     
+ Misses        535      533       -2     

Files with missing lines	Coverage Δ
src/west/app/project.py	79.66% <100.00%> (+0.27%)	⬆️
src/west/manifest.py	94.97% <100.00%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[pdgendt]

LGTM

I spent more than 2s looking at the code and I take that back, sorry.

_as_dict_helper() already has an optional pdict argument which is already used to perform filtering. So, this PR scatters the project filtering in two different places; one "contextual" one and another, new, more "hardcoded" place. Does not look great. Would something like this make more sense? (UNTESTED)

I don't think that would work? The pdict isn't filtering? It would throw.

[marc-hb]

I don't think that would work? The pdict isn't filtering? It would throw.

Yes my bad, ignore. Sorry for the noise.

[marc-hb]

This was already discussed in #491, #667 and probably others. At the time, a new command was suggested instead of changing the semantic of the existing one[*]. Please review past discussions before proceeding with this.

Discussion in
https://discord.com/channels/720317445772017664/733037524498382881/1362257185597554808

Discord is useful but Discord discussions are not public, please avoid using as a reference (try opening this links in private/incognito mode)

[*] Maybe one issue is: different people with different filters get different --freeze outputs? So it's not "deterministic" anymore? I don't know, I don't have time to read all past discussions right now sorry.

[marc-hb]

west manifest --freeze would throw an exception on the first uncloned repo

So this never worked in a default or almost default configuration? Whatever happens, it sounds like more test coverage is needed! CodeCov & friends only know so much...

[EricNRS]

Here is the original bug report from Discord that prompted this change.

Bug report from the Discord discussion

Any tips on how to get west manifest --freeze to work? When I run it, it complains about the projects in zephyr/submanifests/optional.yaml not being cloned starting with the first in the list of canopennode. Since it is optional software that I am not using, it is not cloned, so the entire freeze operation fails.

I am using the "forest" model of west and have a zephyrproject/applications folder which imports the zephyr repo:

manifest:
  remotes:
    - name: zephyrproject-rtos
      url-base: https://github.com/zephyrproject-rtos

  projects:
    - name: zephyr
      revision: v4.0-mainline-dev
      import: true
    # private application repo configurations go here

$ west manifest --freeze
. . .
RuntimeError: cannot freeze; project canopennode is uncloned

I was able to update west to skip uncloned projects to get a release out. Would still like to know if this is a west issue or a usage/configuration issue on my part.

[pdgendt]

This was already discussed in #491, #667 and probably others. At the time, a new command was suggested instead of changing the semantic of the existing one[*]. Please review past discussions before proceeding with this.

Thanks for pointing to those discussions, will update this PR to have --freeze-active and --resolve-active instead.

[marc-hb]

I see nothing wrong but I was never on top of filters and Partial imports Incomplete or changing imports are much more complicated than you think , so at least one of the @mbolivar must review. Ideally, everyone who discussed #666 and others should review too.

[Copilot]

Pull Request Overview

This PR introduces two new command-line arguments—--freeze-active and --resolve-active—for generating a manifest that includes only active projects, leaving the original --freeze and --resolve behaviors unchanged.

• Added new test cases in tests/test_project.py to verify the behavior of active-only manifests.
• Extended the manifest module to support an "active_only" parameter in its as_dict, as_frozen_dict, and YAML output functions.
• Updated the CLI parser and run logic in src/west/app/project.py to recognize and process the new active commands.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
tests/test_project.py	Introduced tests for --freeze-active and --resolve-active behavior to exclude inactive projects.
src/west/manifest.py	Added an "active_only" parameter to as_dict, as_frozen_dict, as_yaml, and related helpers for filtering inactive projects.
src/west/app/project.py	Extended argument parsing and command routing to support --freeze-active and --resolve-active options.

[carlescufi]

@pdgendt Overall this looks great, but just a question from myself. Why not have something like west manifest --resolve --active and west manifest --freeze --active?

[pdgendt]

@pdgendt Overall this looks great, but just a question from myself. Why not have something like west manifest --resolve --active and west manifest --freeze --active?

No particular reason, both options are probably valid, I took the comment from here.

[carlescufi]

@pdgendt Overall this looks great, but just a question from myself. Why not have something like west manifest --resolve --active and west manifest --freeze --active?

No particular reason, both options are probably valid, I took the comment from here.

I see, I personally would rather see a new --active-only flag that can be combined with --resolve and --freeze, as well as help text pointing to this new --active-only when the resolving or freezing fails. But I won't block the PR for this. CC @mbolivar @marc-hb

[Copilot]

Pull Request Overview

This PR introduces the new "--active-only" argument for the manifest commands used in both resolve and freeze operations. Key changes include:

• Adding new test cases to verify that inactive projects are correctly filtered using the active-only flag.
• Updating manifest representation methods (as_dict, as_frozen_dict, as_yaml) to accept an optional active_only parameter that applies a project filter.
• Modifying the project command argument parsing to conditionally disable extra validations when active-only is enabled.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
tests/test_project.py	Added tests to verify behavior with the new active-only flag.
src/west/manifest.py	Integrated the 'active_only' parameter into manifest methods.
src/west/app/project.py	Adjusted command handling for resolve and freeze with active-only.

[carlescufi]

Looks great!

[EricNRS]

Thank you @pdgendt for pushing this through and taking care of several old issues!