-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Packacge name change CANMessage #7129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Changed name of CANMessage package to reflect library guidance
Arduino Lint has suggestions for possible improvements to https://github.com/TamsinRose/CANMessage:
Linting library in CANMessage
INFO: No header file found matching library name (CAN_Message_Arduino.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 name CAN_Message_Arduino contains "Arduino". This is superfluous.
See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
(Rule LP014)
WARNING: library.properties depends field item(s) Seeed_Arduino_CAN not found in the Library Manager index.
See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
(Rule LP048)
Linter results for project: 0 ERRORS, 2 WARNINGS
-------------------
Linting sketch in CANMessage/examples/basic_mcp2515
Linter results for project: no errors or warnings
-------------------
Linting sketch in CANMessage/examples/other_can_interface
Linter results for project: no errors or warnings
-------------------
Linting sketch in CANMessage/examples/serial_output
Linter results for project: no errors or warnings
-------------------
Linter results for projects: 0 ERRORS, 2 WARNINGS
❌ ERROR: Your submission meets all requirements. However, the pull request could not be merged.
Please follow this guide to resolve a merge conflict:
https://docs.github.com/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github
Once that is done, it will be merged automatically.
Hi @TamsinRose.
Your pull request has been detected as something other than a Library Manager submission.
A maintainer will need to review it before it can be merged.
If you intended to submit a library, please check the instructions and update your pull request if necessary:
https://github.com/arduino/library-registry/blob/main/README.md#instructions
❌ ERROR: Arduino Lint found errors with https://github.com/TamsinRose/CANMessage:
Linting library in CANMessage
INFO: No header file found matching library name (CAN_Message_Arduino.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 name CAN_Message_Arduino contains "Arduino". This is superfluous.
See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
(Rule LP014)
ERROR: Library name CAN_Message_Arduino not found in the Library Manager index. Library names are not allowed to change
after being added to the index.
See: https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-change-a-librarys-name
(Rule LP018)
WARNING: library.properties depends field item(s) Seeed_Arduino_CAN not found in the Library Manager index.
See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format
(Rule LP048)
Linter results for project: 1 ERRORS, 2 WARNINGS
-------------------
Linting sketch in CANMessage/examples/basic_mcp2515
Linter results for project: no errors or warnings
-------------------
Linting sketch in CANMessage/examples/other_can_interface
Linter results for project: no errors or warnings
-------------------
Linting sketch in CANMessage/examples/serial_output
Linter results for project: no errors or warnings
-------------------
Linter results for projects: 1 ERRORS, 2 WARNINGS
Thanks for your interest in contributing to the Arduino Library Manager index @TamsinRose
Please resolve the error(s) mentioned in the previous comment.
After resolving the issue, trigger this check again by doing one of the following:
- Commit the required change to the branch you submitted this pull request from.
- Comment here, mentioning
@ArduinoBotin the comment.
❗ NOTE: It is not necessary to open a new pull request. ❗
More information:
https://github.com/arduino/library-registry/blob/main/README.md#if-the-problem-is-with-the-pull-request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @TamsinRose. I am confirming your request.
Unlike submissions, this type of request is still handled manually. The Library Manager index maintainer occasionally comes through to clear all the outstanding requests. They will merge this pull request when it is done. You will get a notification from GitHub at that time.
After that, you can monitor the indexing of the library via its dedicated logs web page.
Information about that here:
https://github.com/arduino/library-registry/blob/main/FAQ.md#can-i-check-on-library-releases-being-added-to-library-manager
Changed name of included package from CAN_Message_Arduino to CANMessage following Arduino library guidance