zephyrproject-rtos/west

west compare (and others) don't sync manifest-rev with west.yml: need "west fetch"

Open

#747 opened on Oct 7, 2024

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Python (157 forks)auto 404
help wantedpriority: medium

Repository metrics

Stars
 (350 stars)
PR merge metrics
 (PR metrics pending)

Description

Initial title: "west compare doesn't detect updated project revisions in manifest"

When running west compare, I expected that if my repo state didn't match the manifest, it would report it.

Actual behaviour: changes to repo are detected. But changes to manifest (e.g. change sha in a project's revision property) are not detected.

Is this the intended behaviour?

In our project, we want to confirm before building that repo state matches the manifest. We do this by running west compare before a build. But this doesn't catch an updated manifest. We have currently worked around this with a west extension which uses west compare and also checks each project repo in the workspace against the revision in the manifest.

Would an update to west compare to include this check be useful to others?

cc:

  • #448
  • #548

Contributor guide

Research direction
Look at the west compare command implementation, specifically how it compares project revisions. The manifest revision is obtained from west.yml, but the command currently only checks the local git state. You need to fetch the manifest revision from the manifest file and compare it with the current revision in the repo.
Tech stack
python
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70