arduino / library-registry

Arduino Library Manager list
https://www.arduino.cc/
Creative Commons Zero v1.0 Universal
240 stars 1.54k forks source link

Library name change request #5026

Closed maciekish closed 3 days ago

maciekish commented 3 weeks ago

Hi, i updated the library.preferences yesterday before submitting to repositories.txt but the library has now appeared in Arduino IDE with the old metadata. Where is this pulled from? The latest library.properties in git or from the latest zipped release? Can you please refresh the metadata? The name is slightly different and there is a 0.3.10 version that doesnt appear in Arduino IDE. Please use the name from library.preferences (DCS-BIOS) so that it is the same both in Arduino IDE and PlatformIO. Thank you.

Library repository URL

https://github.com/DCS-Skunkworks/dcs-bios-arduino-library

per1234 commented 3 weeks ago

Hi @maciekish.

Where is this pulled from? The latest library.properties in git or from the latest zipped release?

Neither. Arduino Library Manager works from Git tags. The library is registered under the name from the name field of the library.properties metadata at the latest tag. At the time of registration, that was DCS-BIOS FP-Fork:

https://github.com/DCS-Skunkworks/dcs-bios-arduino-library/blob/0.3.9/library.properties#L1

name=DCS-BIOS FP-Fork

As for the manually created ZIP file you add to the GitHub release assets, the Arduino Library Manager indexer doesn't know or care anything about it. The library archives that are distributed by Library Manager are made from the contents of the Git repository at each tag.

Please use the name from library.preferences (DCS-BIOS)

I am confirming your request.

Unlike submissions, this type of request is still handled manually. The Library Manager index maintainer occasionally comes through to clear all the outstanding requests. They will close this issue when it is done. You will get a notification from GitHub at that time.

After that, you can monitor the indexing of the library via its dedicated logs web page. Information about that here: https://github.com/arduino/library-registry/blob/main/FAQ.md#can-i-check-on-library-releases-being-added-to-library-manager

maciekish commented 3 weeks ago

Hi, thank you for the explanation. Do you know why it hasn't picked up 0.3.10 yet? Is it because the name has changed? It's still showing 0.3.9 with the old metadata

image

per1234 commented 3 weeks ago

Is it because the name has changed?

Yes. The library is locked to the name it was registered under. The indexer will reject any release that has a different name value in its metadata.

If you check the indexer logs page for your library, you can see the problem:

2024/08/24 23:36:53 Checking out tag: 0.3.10
2024/08/24 23:36:53 Release DCS-BIOS:0.3.10 has wrong library name, should be DCS-BIOS FP-Fork
maciekish commented 3 weeks ago

Yes. The library is locked to the name it was registered under. The indexer will reject any release that has a different name value in its metadata.

Thank you. We'll wait for the manual name change then. Sorry for the extra work.

MatteoPologruto commented 3 days ago

Done:

2024/09/12 15:49:38 Loaded 7300 libraries from DB
Removing DCS-BIOS FP-Fork
Success!