Support for git-downloaded libraries in profiles. #3028
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)configuration.schema.json
updated if new parameters are added.What kind of change does this PR introduce?
This PR adds support for git-based libraries in profiles.
What is the current behavior?
Sketch profiles do not support libraries downloaded from git.
Only libraries available on the Libraries Index or in the local storage could be included in a build made with profiles.
What is the new behavior?
Now the profiles support a third kind of library, and a git reference could be indicated in the profiles, like in the following example:
The specific git-revision of the library specified in the profile will be downloaded from git and cached in the data directory's
internal
folder. The downloaded copy is cached only the first time and will not be downloaded again.If the git-reference is updated on the repository, the cached copy will become outdated, and the only way to refresh it is to delete the internal cache directory to force the Arduino CLI to download it again.
For example, a user trying to always utilize the latest
main
branch of a library might be tempted to write something like:BTW, this won't work well because, after the first compile (and download from git), the Arduino CLI will never try again to refresh the library.
Does this PR introduce a breaking change, and is titled accordingly?
No
Other information
Fix #2133