-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Library Manager FAQ
From a list of public Git repos, a job (a small program that runs regularly) fetches every tag, verifies library files and pushes the updated list onto the Arduino download server. Only valid libraries and their tags are published. A library is not valid when:
- it's not in 1.5 format and in particular it misses a library.properties file (1.5 format folder layout is not required)
- its version number is not semver compliant
- it contains
.exefiles - it contains a
.developmentfile - it contains symlinks
- our antivirus finds infected files
The job runs every hour. If a new library has been released, you can expect it to be listed within the hour.
- Your library repository must be hosted on a major git-hosting website like GitHub, BitBucket or GitLab (other hosting site may be considered on request).
- Ensure your library is compliant with 1.5 format (1.5 format folder layout is not required)
- Tag it and push the tag (or create a release if you web hosting offers a way to do it, for example with GitHub "releases")
- Open an issue on Arduino's GitHub, specifying the URL of the repository from where to download your library
- After some days, a member of the Arduino team will add your library to the Library Manager index and close the issue. Shortly after that your library will be available for installation via Library Manager.
Ensure you've changed version in your library.properties. Then tag your library once more and push the new tag (or create a release if your web hosting offers a way to do it, for example with GitHub "releases").
Our indexer checks for new releases every hour and will eventually fetch and publish your new release.
In order to change contents of an already published library version, you can recreate its related tag.
In order to unpublish a library version, delete its related tag/release.
Modified or Deleted library versions are processed every Sunday.
Open your sketchbook "libraries" folder with your OS file explorer (Windows: Explorer, Mac: Finder, Linux: Nautilus, kfiles...) and delete the folder containing your library.
No, we don't have a delete button. Libraries managed by the Library Manager are mixed with those you've manually installed, maybe libraries you've written: making a mistake and deleting the wrong library is too easy. That's why trash bins exist. Since the IDE has no knowledge of your trash bin, we didn't implement a "delete" button.
Your repo is OK if its root folder contains the file library.properties and the rest of the library source code. If your library is stored in a subfolder, your repo is not OK and we can't include your library in the list.
No. The library archive distributed by Library Manager will only contain an empty folder where the submodule should be.
No. At the moment, the IDE handles one URL only, and that's written into the code (dev jargon: it's hardcoded), this is a known limitation. However, if you know your way through the code, you can change that URL with another one.
When I install a library that I know depends on another library, will this other library be installed as well?
No, at the moment library dependencies are ignored. Current Library Manager aims at simplifying your life when dealing with installing a single library. If a library depends on another one, you'll have to install both.
Library Manager installs libraries into your sketchbook "libraries" folder. Since you cannot create two folders with the same name, we can't install two versions of the same library. However, you can switch between library versions, by selecting the appropriate one from the version dropdown that pops up on Library Manager when more than one version is available.