Skip to content

arduinoAnimation library #2057

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

Merged
merged 2 commits into from
Nov 16, 2022
Merged

arduinoAnimation library #2057

merged 2 commits into from
Nov 16, 2022

Conversation

npuckett
Copy link
Contributor

@npuckett npuckett commented Nov 4, 2022

No description provided.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

A problem was found with your submission https://github.com/npuckett/arduinoAnimation

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 github-actions bot added the topic: submission Add library to the list label Nov 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

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

@npuckett
Copy link
Contributor Author

npuckett commented Nov 4, 2022

@ArduinoBot please check again

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

Hello! I'm checking your submission again.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

A problem was found with your submission https://github.com/npuckett/arduinoAnimation

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

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

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

@npuckett
Copy link
Contributor Author

npuckett commented Nov 4, 2022

@ArduinoBot

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

Hello! I'm checking your submission again.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

ERROR: Arduino Lint found errors with https://github.com/npuckett/arduinoAnimation:

Linting library in arduinoAnimation
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 (Animation_Tools.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 name Animation Tools contains spaces. Although supported, best practices is to not use      
         spaces.                                                                                                        
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP015)                                                                                                   
WARNING: library.properties version value 0.5 is not compliant with the semver specification.
         See: https://semver.org/                                                            
         (Rule LP021)                                                                        
WARNING: Unable to load the library.properties url field: Head "hhttps://github.com/npuckett/arduinoAnimation":         
         unsupported protocol scheme "hhttps"                                                                           
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP042)                                                                                                   
WARNING: No license file found.                                                                                                                 
         See:                                                                                                                                   
         https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
         (Rule LD002)                                                                                                                           
WARNING: Sketch(es) found outside examples and extras folders:                                    
           arduinoAnimation/animationTools/examples/sensorTriggerMoveTo                           
           arduinoAnimation/animationTools/examples/sensorTriggerTwoTimelines                     
           arduinoAnimation/animationTools/examples/simpleMoveTo                                  
           arduinoAnimation/animationTools/examples/simpleOscillate                               
           arduinoAnimation/animationTools/examples/simpleTimeline                                
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#library-examples
         (Rule LD003)                                                                             
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, 6 WARNINGS

-------------------

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

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

@per1234
Copy link
Contributor

per1234 commented Nov 4, 2022

Hello @npuckett. Thanks for your interest in contributing to the Arduino Library Manager index.

I see the bot reported a problem with your submission that will block its acceptance:

ERROR: Path does not contain a valid Arduino library.

The reason for this error is that your library is located in the animationTools subfolder of your repository:

https://github.com/npuckett/arduinoAnimation/tree/master/animationTools

arduinoAnimation/
├── README.md
├── animationTools/
│   ├── animationTools.h
│   └── examples/
│       └── ...
└── library.properties

The required repository structure looks like this:

arduinoAnimation/
├── README.md
├── animationTools.h
├── examples/
│   └── ...
└── library.properties

So you only need to move animationTools.h and the examples folder up one folder level.

After that, you will need to make a new release of the version of library that meets the requirements.

Remember to update the version field in the library's library.properties file as needed before making a new release or tag in the library repository.

Once you have done that, simply mention @ArduinoBot in a comment here to trigger it to run the automated checks again. After those are passing, your library will automatically be added to Library Manager.

If you have any questions or concerns, please let me know.

If you have any questions or problems while following the instructions to resolve the problem, please let me know and I'll help out.

@per1234 per1234 self-assigned this Nov 4, 2022
@per1234 per1234 added the status: waiting for information More information must be provided before work can proceed label Nov 4, 2022
@per1234
Copy link
Contributor

per1234 commented Nov 9, 2022

Hi @npuckett. Since there was no sign of progress on resolving the issue, I submitted a pull request for the necessary changes to your library:

npuckett/arduinoAnimation#1

Please merge that and then make a release as I described above so we can move forward with adding your library.

@github-actions github-actions bot removed the status: waiting for information More information must be provided before work can proceed label Nov 16, 2022
@github-actions
Copy link
Contributor

Arduino Lint has suggestions for possible improvements to https://github.com/npuckett/arduinoAnimation:

Linting library in arduinoAnimation
INFO: No header file found matching library name (Animation_Tools.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 name Animation Tools contains spaces. Although supported, best practices is to not use      
         spaces.                                                                                                        
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP015)                                                                                                   
WARNING: library.properties version value 0.6 is not compliant with the semver specification.
         See: https://semver.org/                                                            
         (Rule LP021)                                                                        
WARNING: Unable to load the library.properties url field: Head "hhttps://github.com/npuckett/arduinoAnimation":         
         unsupported protocol scheme "hhttps"                                                                           
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP042)                                                                                                   
WARNING: No license file found.                                                                                                                 
         See:                                                                                                                                   
         https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
         (Rule LD002)                                                                                                                           

Linter results for project: 0 ERRORS, 4 WARNINGS

-------------------

Linting sketch in arduinoAnimation/examples/sensorTriggerMoveTo

Linter results for project: no errors or warnings

-------------------

Linting sketch in arduinoAnimation/examples/sensorTriggerTwoTimelines

Linter results for project: no errors or warnings

-------------------

Linting sketch in arduinoAnimation/examples/simpleMoveTo

Linter results for project: no errors or warnings

-------------------

Linting sketch in arduinoAnimation/examples/simpleOscillate

Linter results for project: no errors or warnings

-------------------

Linting sketch in arduinoAnimation/examples/simpleTimeline

Linter results for project: no errors or warnings

-------------------

Linter results for projects: 0 ERRORS, 4 WARNINGS

@github-actions github-actions bot merged commit 6f700b2 into arduino:main Nov 16, 2022
@github-actions
Copy link
Contributor

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/npuckett/arduinoAnimation/

github-actions bot pushed a commit that referenced this pull request Nov 16, 2022
@npuckett npuckett deleted the patch-1 branch March 9, 2024 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: submission Add library to the list
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants