README
¶
libraries-repository-engine
This is the tool that generates the Arduino Library Manager index.
Every hour, the automated Library Manager indexer system runs this tool, which:
- checks every repository in the Library Manager list for new tags
- checks whether those tags meet the requirements for addition to the index, publishing logs
- adds entries to the index for compliant tags
- pushes the updated index to Arduino's download server
BUILD
task go:build
TDD
In order to run the tests, type
task go:test
RUN
Create a config.json file (or edit example one). Same thing for repos.txt file.
Run the following command to list the available command line interfaces:
./libraries-repository-engine help
Security
If you think you found a vulnerability or other security-related bug in this project, please read our security policy and report the bug to our Security Team 🛡️ Thank you!
e-mail contact: security@arduino.cc
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
backup
Package backup does backup and restore of files.
|
Package backup does backup and restore of files. |
|
cli
Package cli defines the command line interface.
|
Package cli defines the command line interface. |
|
command/modify
Package modify implements the `modify` CLI subcommand used by the maintainer for modifications to the library registration data.
|
Package modify implements the `modify` CLI subcommand used by the maintainer for modifications to the library registration data. |
|
command/remove
Package remove implements the `remove` CLI subcommand used by the maintainer for removals of libraries or releases.
|
Package remove implements the `remove` CLI subcommand used by the maintainer for removals of libraries or releases. |
|
command/sync
Package sync implements the `sync` CLI subcommand that updates the Library Manager content.
|
Package sync implements the `sync` CLI subcommand that updates the Library Manager content. |
|
configuration
Package configuration handles the tool configuration.
|
Package configuration handles the tool configuration. |
|
feedback
Package feedback provides feedback to the user.
|
Package feedback provides feedback to the user. |
|
libraries/archive
Package archive handles the library release archive.
|
Package archive handles the library release archive. |
|
libraries/metadata
Package metadata handles library.properties metadata.
|
Package metadata handles library.properties metadata. |
Click to show internal directories.
Click to hide internal directories.