arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-04-19 03:42:17 +03:00
Code

Add instructions to FAQ for accessing indexer logs

Browse Source 
The Library Manager indexer logs are available for each library in the index. Example:
http://downloads.arduino.cc/libraries/logs/github.com/cmaglie/FlashStorage/

This can be a valuable tool for monitoring the indexing of releases, allowing the library authors to troubleshoot without
the need for assistance from a maintainer of this repository.
This commit is contained in:
per1234 2021-04-25 22:46:06 -07:00
parent 7ebdf19341
commit db48a0f2b7
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
FAQ.md
View File

@ -15,6 +15,7 @@
- [How can I publish a new release once my library is in the list?](#how-can-i-publish-a-new-release-once-my-library-is-in-the-list) - [How can I publish a new release once my library is in the list?](#how-can-i-publish-a-new-release-once-my-library-is-in-the-list)
- [What are the requirements for publishing new releases of libraries already in the Library Manager list?](#what-are-the-requirements-for-publishing-new-releases-of-libraries-already-in-the-library-manager-list) - [What are the requirements for publishing new releases of libraries already in the Library Manager list?](#what-are-the-requirements-for-publishing-new-releases-of-libraries-already-in-the-library-manager-list)
- [Why aren't releases of my library being picked up by Library Manager?](#why-arent-releases-of-my-library-being-picked-up-by-library-manager) - [Why aren't releases of my library being picked up by Library Manager?](#why-arent-releases-of-my-library-being-picked-up-by-library-manager)
- [Can I check on library releases being added to Library Manager?](#can-i-check-on-library-releases-being-added-to-library-manager)
- [I did something wrong! How can I change or unpublish an already published library?](#i-did-something-wrong-how-can-i-change-or-unpublish-an-already-published-library) - [I did something wrong! How can I change or unpublish an already published library?](#i-did-something-wrong-how-can-i-change-or-unpublish-an-already-published-library)
- [How can I change a library's name?](#how-can-i-change-a-librarys-name) - [How can I change a library's name?](#how-can-i-change-a-librarys-name)
- [Limitations](#limitations) - [Limitations](#limitations)
@ -52,7 +53,7 @@ More information:
Every hour, the automated Library Manager indexer system: Every hour, the automated Library Manager indexer system:
1. checks every repository in the Library Manager list for new tags 1. checks every repository in the Library Manager list for new tags, updating [the logs](#can-i-check-on-library-releases-being-added-to-library-manager) accordingly
1. checks whether those tags meet [the requirements for addition to the index](#update-requirements) 1. checks whether those tags meet [the requirements for addition to the index](#update-requirements)
1. adds entries to the index for compliant tags 1. adds entries to the index for compliant tags
1. pushes the updated index to Arduino's download server 1. pushes the updated index to Arduino's download server
@ -117,6 +118,20 @@ Note that libraries will need to be compliant with [all requirements](#update-re
The Library Manager indexer job will reject any releases which aren't compliant with all [the requirements](#update-requirements). The Library Manager indexer job will reject any releases which aren't compliant with all [the requirements](#update-requirements).
You can check [the indexer logs](#can-i-check-on-library-releases-being-added-to-library-manager) for information about what happened.
### Can I check on library releases being added to Library Manager?
There is a dedicated web page for each library that shows the logs from the Library Manager indexer. The URL of the logs page is based on the library's repository URL:
```
http://downloads.arduino.cc/libraries/logs/<host>/<repository slug>/
```
For example, the Servo library is hosted at https://github.com/arduino-libraries/Servo, so its logs are at:
http://downloads.arduino.cc/libraries/logs/github.com/arduino-libraries/Servo/
### I did something wrong! How can I change or unpublish an already published library? ### I did something wrong! How can I change or unpublish an already published library?
In order to change contents of an already published library version, you can recreate its related tag. In order to change contents of an already published library version, you can recreate its related tag.