3ec30a80ba
In order to facilitate the testing and review of proposed changes to the repository label infrastructure, the "Sync Labels" template workflow does a dry run when triggered under conditions that indicate it would not be appropriate to make real changes to the repository's labels. The changes that would have resulted are printed to the log, but not actually made. One of the criteria used to determine "dry run" mode usage is whether the event occurred on the repository's default branch. A trigger on a development branch or for a pull request should not result in a change to the labels. It turns out that GitHub does not define a `github.event.repository.default_branch` context item when a workflow is triggered by a `schedule` event. This resulted in the workflow always running in "dry run" mode on a `schedule` trigger. Since `schedule` and `repository_dispatch` triggers are only permitted for the default branch, there is no need to check whether the event's ref matches the default branch and it is safe to always run in write mode on these events.
Arduino Library Manager list
This repository contains the list of libraries in the Arduino Library Manager index.
Table of Contents
- Frequently asked questions
- Adding a library to Library Manager
- Changing the URL of a library already in Library Manager
- Removing a library from Library Manager
- Report a problem with Library Manager
Frequently asked questions
For more information about Arduino Library Manager and how the index is maintained, please see the FAQ.
Adding a library to Library Manager
If you would like to make a library available for installation via Library Manager, just submit a pull request that adds the repository URL to the list. You are welcome to add multiple libraries at once.
See the instructions below for detailed instructions on how to do this via the GitHub web interface.
Instructions
- You may want to first take a look at the requirements for admission into the Arduino Library Manager index. Each submission will be checked for compliance before being accepted.
- Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt
- Click the Fork this repository button.
- Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example:
https://github.com/arduino-libraries/Servo - Click the Propose changes button.
- In the "Comparing changes" window that opens, click the Create pull request button.
- In the "Open a pull request" window that opens, click the Create pull request button.
The library will be automatically checked for compliance as soon as the pull request is submitted. If no problems were found, the pull request will be immediately merged and the library will be available for installation via Library Manager within a day's time.
If any problems are found, a bot will comment on the pull request to tell you what is wrong. The problem may be either with your pull request or with the library.
If the problem is with the pull request:
Edit the file in the
branch
you submitted the pull request from in your fork of the arduino/library-registry repository, then commit.
Doing this will update the pull request and cause the automated checks to run again.
If the problem is with the library:
- Make the necessary fix in the library repository.
- Increment the
versionvalue in the library's library.properties file. - Create a release or tag. The Library Manager index always uses tagged versions of the libraries, so even if the development version of the library is compliant, it can't be accepted until the latest release or tag is compliant. Alternatively, you can redo the existing release/tag if you prefer.
- Comment on your pull request here in the
arduino/library-registryrepository, mentioning @ArduinoBot in the comment. Doing this will cause the automated check to run again.
Changing the URL of a library already in Library Manager
Submit a pull request that changes the URL as desired in repositories.txt. This can be done by following the instructions above.
Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being changed.
Removing a library from Library Manager
Submit a pull request that removes the URL from repositories.txt. This can be done by following the instructions above.
Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being removed.
Report a problem with Library Manager
First, please take a look at the FAQ. If a library release is missing from Library Manager, it is usually because it was not compliant with all the requirements listed in that document.
This repository is not an appropriate place to request support or report problems with a library. Check the library's own documentation for instructions or ask on the Arduino Forum.
If the problem is about something else, please make an issue report here: https://github.com/arduino/library-registry/issues?q=is%3Aissue