arduino / library-registry

Arduino Library Manager list
https://www.arduino.cc/
Creative Commons Zero v1.0 Universal
223 stars 1.41k forks source link

Update repositories.txt #1846

Closed chibiegg closed 1 year ago

github-actions[bot] commented 1 year ago

A problem was found with your submission https://github.com/chibiegg/esp-echonet-lite

:x: ERROR: Library is missing a library.properties metadata file.

See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata

github-actions[bot] commented 1 year ago

Thanks for your interest in contributing to the Arduino Library Manager index @chibiegg Please resolve the error(s) mentioned in the previous comment.

After resolving the issue, trigger this check again by doing one of the following:

:exclamation: NOTE: It is not necessary to open a new pull request. :exclamation:

More information: https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request

chibiegg commented 1 year ago

@ArduinoBot please retry

github-actions[bot] commented 1 year ago

Hello! I'm checking your submission again.

github-actions[bot] commented 1 year ago

A problem was found with your submission https://github.com/chibiegg/esp-echonet-lite

:x: ERROR: Library is missing a library.properties metadata file.

See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata

github-actions[bot] commented 1 year ago

Thanks for your interest in contributing to the Arduino Library Manager index @chibiegg Please resolve the error(s) mentioned in the previous comment.

After resolving the issue, trigger this check again by doing one of the following:

:exclamation: NOTE: It is not necessary to open a new pull request. :exclamation:

More information: https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request

chibiegg commented 1 year ago

@ArduinoBot

github-actions[bot] commented 1 year ago

Hello! I'm checking your submission again.

github-actions[bot] commented 1 year ago

Hi @chibiegg. There was an unexpected failure during automated processing of your pull request. This error is unrelated to the content of your pull request.

A maintainer has been notified and will investigate as soon as possible.

chibiegg commented 1 year ago

I’m sorry to bother you.

per1234 commented 1 year ago

Hi @chibiegg. Thanks for your interest in adding a library to the Arduino Library Manager!

The reason for the failure is that there is a symlink loop in your library (the automated system doesn't communicate very well about this problem currently):

panic: symlink depth exceeded maximum while finding projects under esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite/examples/Arduino/electricraindoor/lib/esp-echonet-lite

They are here:

This specific type of symlink that links back to a parent path, and thus causes an infinite loop while recursively walking the library folder is especially problematic, but in fact libraries that contain a symlink of any kind are prohibited from admission to the Arduino Library Manager index:

https://github.com/arduino/library-registry/blob/main/FAQ.md#submission-requirements

So you will need to remove these symlinks from the library if you wish to add it.

After removing them, you will need to create a new release:

  1. Update the version value in library.properties to the version that will be used for the new release.
  2. Create a new release or tag in the library repository.

After doing that, you can trigger another run of the checks by mentioning the bot, as you did before (thanks!).

If you decide you no longer wish to add your library, you can close this PR, but we hope you will add it after all.

Please let me know if you have any questions or concerns. Regards, Per

chibiegg commented 1 year ago

Thanks. @ArduinoBot please retry

github-actions[bot] commented 1 year ago

Hello! I'm checking your submission again.

github-actions[bot] commented 1 year ago

:x: ERROR: Arduino Lint found errors with https://github.com/chibiegg/esp-echonet-lite:

Linting library in esp-echonet-lite
ERROR: Path does not contain a valid Arduino library.                         
       See: https://arduino.github.io/arduino-cli/latest/library-specification
       (Rule LS001)                                                           
INFO: No header file found matching library name (esp-echonet-lite.h). Best practices are for primary header filename to
      match library name.                                                                                               
      See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format            
      (Rule LS008)                                                                                                      
WARNING: library.properties includes field item(s) echonet.h not found in library.                             
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
         (Rule LP052)                                                                                          
WARNING: No example sketches found. Please provide examples.                                      
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD004)                                                                             

Linter results for project: 1 ERRORS, 2 WARNINGS

-------------------
github-actions[bot] commented 1 year ago

Thanks for your interest in contributing to the Arduino Library Manager index @chibiegg Please resolve the error(s) mentioned in the previous comment.

After resolving the issue, trigger this check again by doing one of the following:

:exclamation: NOTE: It is not necessary to open a new pull request. :exclamation:

More information: https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request

per1234 commented 1 year ago

Hi again. About this error reported by the bot:

ERROR: Path does not contain a valid Arduino library.                         
      See: https://arduino.github.io/arduino-cli/latest/library-specification
      (Rule LS001)                                                           

The reason for this is that there is no header file in the root of the src subfolder.

The Arduino library framework requires that there be at least one header file in the root of the source folder. This header file is used for discovery of the library. It means the user only needs to add something like this to their sketch:

#include <echonet.h>

and the library will be compiled recursively and added to the compiler include path (via a -I flag).

There is no requirement about the name of the header file (though it is best practices to make it match the name value from the library.properties file: esp-echonet-lite.h), nor what the content of the header file must be. It could be an empty file that is only used for discovery.

chibiegg commented 1 year ago

Sorry, I separated include and src directory. I integrated include directory to src. @ArduinoBot Please retry

github-actions[bot] commented 1 year ago

Hello! I'm checking your submission again.

github-actions[bot] commented 1 year ago

Arduino Lint has suggestions for possible improvements to https://github.com/chibiegg/esp-echonet-lite:

Linting library in esp-echonet-lite
INFO: No header file found matching library name (esp-echonet-lite.h). Best practices are for primary header filename to
      match library name.                                                                                               
      See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format            
      (Rule LS008)                                                                                                      
WARNING: No example sketches found. Please provide examples.                                      
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD004)                                                                             

Linter results for project: 0 ERRORS, 1 WARNINGS

-------------------
github-actions[bot] commented 1 year ago

Your submission has now been accepted! Thanks for your contribution to the Arduino Library Manager index.

The library(s) will be available for installation via Library Manager within a day's time.

You can check the logs from the Library Manager indexer for your library(s) here: http://downloads.arduino.cc/libraries/logs/github.com/chibiegg/esp-echonet-lite/

chibiegg commented 1 year ago

Thanks!