Skip to content

Conversation

silvanocerza
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Enhances an existing command.

  • What is the current behavior?

Calling lib install with --zip-file or --git-url doesn't check if the used zip or git repository contain a valid library.

This affects also the gRPC interface.

  • What is the new behavior?

Calling lib install with --zip-file or --git-url now checks if the used zip or git repository contain a valid library and fails if it not.

A valid library must contain an header file with the same name as the library and a library.properties file as documented.
https://arduino.github.io/arduino-cli/latest/library-specification

This affects also the gRPC interface.

Nope.

  • Other information:

None.


See how to contribute

@silvanocerza silvanocerza requested a review from a team March 24, 2021 15:33
@silvanocerza silvanocerza self-assigned this Mar 24, 2021
@silvanocerza silvanocerza changed the title Add library validation when installing from zip or git Add library validation step when installing from zip or git Mar 24, 2021
@silvanocerza silvanocerza force-pushed the scerza/validate-lib-install branch from acc5715 to a49e375 Compare March 24, 2021 16:36
Copy link
Contributor

@umbynos umbynos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🐎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants