search

arduino / library-registry

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

Update repositories.txt #1276

Closed Tinyu-Zhao closed 2 years ago

github-actions[bot] commented 2 years ago

A problem was found with your submission https://github.com/Tinyu-Zhao/M5-Arduino-Depends

:x: ERROR: Unable to load submission URL. Is the repository public?

github-actions[bot] commented 2 years ago

Thanks for your interest in contributing to the Arduino Library Manager index @Tinyu-Zhao 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

Tinyu-Zhao commented 2 years ago

@ArduinoBot

github-actions[bot] commented 2 years ago

Hello! I'm checking your submission again.

github-actions[bot] commented 2 years ago

A problem was found with your submission https://github.com/Tinyu-Zhao/M5-Arduino-Depends

:x: ERROR: The repository has no tags. You need to create a release or tag that matches the version value in the library's library.properties file.

github-actions[bot] commented 2 years ago

Thanks for your interest in contributing to the Arduino Library Manager index @Tinyu-Zhao 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

Tinyu-Zhao commented 2 years ago

@ArduinoBot

github-actions[bot] commented 2 years ago

Hello! I'm checking your submission again.

github-actions[bot] commented 2 years ago

:x: ERROR: Arduino Lint found errors with https://github.com/Tinyu-Zhao/M5-Arduino-Depends:

Linting library in M5-Arduino-Depends
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 (M5-Arduino-Depends.h). Best practices are for primary header filename 
      to match library name. (Rule LS008)                                                                               
WARNING: library.properties name value M5-Arduino-Depends is longer than the recommended length of 16 characters. (Rule 
         LP010)                                                                                                         
WARNING: Library name M5-Arduino-Depends contains "Arduino". This is superfluous. (Rule LP014)
WARNING: library.properties depends field item(s) ESP32CAN, UNIT_PoESP32, MODULE_4RELAY not found in the Library Manager
         index. (Rule LP048)                                                                                            
WARNING: Empty library.properties includes field. Please either define includes or remove this optional field. See      
         https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format (Rule LP051) 
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, 5 WARNINGS

-------------------
github-actions[bot] commented 2 years ago

Thanks for your interest in contributing to the Arduino Library Manager index @Tinyu-Zhao 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

Tinyu-Zhao commented 2 years ago

@ArduinoBot

github-actions[bot] commented 2 years ago

Hello! I'm checking your submission again.

github-actions[bot] commented 2 years ago

:x: ERROR: Arduino Lint found errors with https://github.com/Tinyu-Zhao/M5-Arduino-Depends:

Linting library in M5-Depends
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 (M5-Depends.h). Best practices are for primary header filename to match
      library name. (Rule LS008)                                                                                        
WARNING: Empty library.properties includes field. Please either define includes or remove this optional field. See      
         https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format (Rule LP051) 
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 2 years ago

Thanks for your interest in contributing to the Arduino Library Manager index @Tinyu-Zhao 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 2 years ago

Hi @Tinyu-Zhao. The reason the check is failing is because the library does not contain a header file. Even in a case like this where the library is a "shell" used only as a container for other assets, it is still necessary to add a .h file as usual. That file can be empty (though I recommend adding a comment to the file to explain the reason for its existence).

You can see an example of such a "shell" library here:

https://github.com/arduino-libraries/Arduino_BuiltIn

Note the header file that makes it a valid library:

https://github.com/arduino-libraries/Arduino_BuiltIn/blob/main/src/Arduino_BuiltIn.h

If you have any questions or concerns, please let me know and I'll help out.

If you decide you no longer wish to submit the library, you can close this pull request.

Tinyu-Zhao commented 2 years ago

This is very helpful for me, thank you

Tinyu-Zhao commented 2 years ago

@ArduinoBot

github-actions[bot] commented 2 years ago

Hello! I'm checking your submission again.

github-actions[bot] commented 2 years ago

Arduino Lint has suggestions for possible improvements to https://github.com/Tinyu-Zhao/M5-Arduino-Depends:

Linting library in M5-Depends
WARNING: Empty library.properties includes field. Please either define includes or remove this optional field. See      
         https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format (Rule LP051) 
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, 2 WARNINGS

-------------------
github-actions[bot] commented 2 years ago

:x: ERROR: Your submission meets all requirements. However, the pull request could not be merged.

Please follow this guide to sync your fork: https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

Once that is done, it will be merged automatically.