Use relative paths for local paths in dependencies.lock (PACMAN-1040)

[Bryght-Labs-Richard]

Related area

commit churn

Is your feature request related to a problem?

The dependencies.lock file encodes the local path to one of my components. Every time dependencies are re-evaluated, this creates silly changes in the repository, and makes it difficult to reproduce building the project from scratch. I believe this only happens to a component I've forked from Espressif, probably because I haven't added idf_component.yml to my other local components.

Describe the solution you'd like

Instead of:

path: C:\Projects\SuperCoolProject\components\espressif__esp_websocket_client

Please consider:

path: .\components\espressif__esp_websocket_client

Describe alternatives you've considered

I could remove idf_component.yml from my forked component, is that what I should do?

I tried editing dependencies.lock manually, but idf.py reconfigure overwrote it.

Additional context

No response

I have checked existing list of Feature requests and I have provided enough information.

• I confirm I have checked existing list of Feature requests and I have provided enough information.

[Bryght-Labs-Richard]

I did find this documentation link, but we'd prefer to use a few local components and ensure all developers use the same component versions.

[kumekay]

Hello @bryghtlabs-richard
Thank you for opening the ticket,
In general, it will be difficult to do for all the local components and keep the compatibility, but probably we can make different rules for components in the components directory in the project.

[MastermindPanda]

I've also stumbled upon this problem

@bryghtlabs-richard What is your current workaround? Thanks!

[Bryght-Labs-Richard]

@MastermindPanda , merge conflicts

[Bryght-Labs-Richard]

Looks like ESP-IDF6 is much closer, but still using an unportable path separator:

[kumekay]

@bryghtlabs-richard Thanks for sharing feedback, we should use posix paths in the lock, it slipped through though. We will take a look!

[XDanielPaul]

@bryghtlabs-richard

I have released a new IDF Component Manager version, could you try to reproduce the issue and confirm if it's been fixed on your side?

[Bryght-Labs-Richard]

@XDanielPaul , with idf-component-manager version 3.0.3, I can confirm that it's using '/' instead of '', thank you!

On Windows, this seems to require a case-insensitive filesystem to work, though could be unrelated to your fixes. On Windows with a case-sensitive filesystem I get several extra ../ up to the root of the project followed by the path within the project, like path: ../../../RepoRoot/ESP32/components/espressif__esp_websocket_client

EDIT: after re-running idf.py reconfigure a few times, the above ../ weirdness resolved itself, all good here!

[XDanielPaul]

@bryghtlabs-richard Great to hear! 🚀

I’ll go ahead and close the issue then. If anything unusual comes up again, feel free to reopen it or create a new issue.

Thank you for your cooperation, and sorry it took longer than expected to get this resolved after I picked it up.

[Bryght-Labs-Richard]

No worries - thank you for fixing it!