Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add repository URL field to the Library Manager index #7591

Closed
per1234 opened this issue May 12, 2018 · 12 comments
Closed

Add repository URL field to the Library Manager index #7591

per1234 opened this issue May 12, 2018 · 12 comments
Labels
Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix)

Comments

@per1234
Copy link
Collaborator

per1234 commented May 12, 2018

The Library Manager indexer job must work off a list of repository URLs but this information is not shared in the index file:
http://downloads.arduino.cc/libraries/library_index.json
The repository URL is not needed for the Arduino IDE's Library Manager but it could be very useful for alternative uses of the index by 3rd parties.

url uses the library name as defined by library.properties rather than the repository name and there is no guarantee they are the same. website does not necessarily point to the repository.

@s-celles
Copy link

This could help both #7567 and #6646

https://github.com/scls19fr/arduino_libraries_search can help to automate a part of the task of retrieving a repository url from archive url and website url but sometimes that's not enough.

@njh
Copy link

njh commented May 21, 2018

This would be really useful.

For the arduinolibraries.info website I am currently having to track the repository URLs manually myself in a Google spreadsheet (where they can't be guessed).

@s-celles
Copy link

It could be great if you could merge your manually tracked data (when repositories url exists and is still available)

@cmaglie
Copy link
Member

cmaglie commented May 21, 2018

The repository URL is now available on the library_index.json:

    {
      "name": "WiFi101",
      "version": "0.10.0",
      "author": "Arduino",
      "maintainer": "Arduino \[email protected]\u003e",
      "sentence": "Network driver for ATMEL WINC1500 module (used on Arduino/Genuino Wifi Shield 101 and MKR1000 boards)",
      "paragraph": "This library implements a network driver for devices based on the ATMEL WINC1500 wifi module",
      "website": "http://www.arduino.cc/en/Reference/WiFi101",
      "category": "Communication",
      "architectures": [
        "*"
      ],
      "types": [
        "Arduino"
      ],
      "repository": "https://github.com/arduino-libraries/WiFi101.git",      <---------
      "provides_includes": [
        "WiFi101.h"
      ],
      "url": "http://downloads.arduino.cc/libraries/github.com/arduino-libraries/WiFi101-0.10.0.zip",
      "archiveFileName": "WiFi101-0.10.0.zip",
      "size": 209803,
      "checksum": "SHA-256:649f69cb2833d591c8962e99b4b5b85c89d1fc58e6e09e4b2966f9010191e120"
    },

@cmaglie cmaglie closed this as completed May 21, 2018
@njh
Copy link

njh commented May 24, 2018

This is fantastic, thanks @cmaglie.

Having done some checks with the new repository field, I have found that some repositories have moved.

Should I create a ticket with a list of updates?

@s-celles
Copy link

I noticed in bblanchon/ArduinoJson@7e4fcb0
that repository field is (was) also used by some libraries in library.properties

Maybe wiki should document such a field usage.

@cmaglie
Copy link
Member

cmaglie commented May 31, 2018

that repository field is (was) also used by some libraries in library.properties

It's not part of the library.properties because it's not needed (the library indexer has his own list).

Moreover, if at some point the repository is moved the old releases will retain the old repository value (because the git history can not be changed).

@njh

Should I create a ticket with a list of updates?

Github automatically redirects to the new url, so it's not really a problem right now.
It should be implemented as a check inside the indexer to update the URL automatically, I'll keep a note about that, but low priority.

@s-celles

This comment was marked as off-topic.

@s-celles

This comment was marked as off-topic.

@per1234

This comment was marked as resolved.

@orkungedik
Copy link

Hi,

Even though I am able to see my library in https://downloads.arduino.cc/libraries/library_index.json, why I can't see on Arduino IDE library list?

Thank you for your support.

Orkun Gedik

@per1234
Copy link
Collaborator Author

per1234 commented Apr 25, 2024

@orkungedik I can see it:

image

So if you can't see it then it means the problem is specific to your system. This repository is only used for tracking bug reports and feature request, not for user support. The appropriate place for support requests is Arduino Forum:

https://forum.arduino.cc/

If you post about your problem over there, I'll be happy to provide assistance.

@arduino arduino locked as resolved and limited conversation to collaborators Apr 25, 2024
@per1234 per1234 added the feature request A request to make an enhancement (not a bug fix) label Apr 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

5 participants