Skip to content

Adding 'Adafruit_SSD1306_EMULATOR' #1777

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 1 commit into from
Aug 30, 2022
Merged

Conversation

sam-peach
Copy link
Contributor

A required library for an open-source emulator I'm about to release :)

@github-actions github-actions bot added the topic: submission Add library to the list label Aug 30, 2022
@github-actions
Copy link
Contributor

ERROR: Arduino Lint found errors with https://github.com/sam-peach/Adafruit_SSD1306_EMULATOR:

Linting library in Adafruit_SSD1306_EMULATOR
WARNING: library.properties name Adafruit SSD1306 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)                                                                                                   
ERROR: Library name Adafruit SSD1306 is in use by a library in the Library Manager index. Each library must have a      
       unique name value. If your library is already in the index, use the "--library-manager update" flag.             
       See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format           
       (Rule LP017)                                                                                                     
WARNING: The library.properties paragraph field repeats the sentence field. These are displayed together so redundancy  
         is not needed.                                                                                                 
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP036)                                                                                                   

Linter results for project: 1 ERRORS, 2 WARNINGS

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/OLED_featherwing

Linter results for project: no errors or warnings

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x32_i2c

Linter results for project: no errors or warnings

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x32_spi

Linter results for project: no errors or warnings

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x64_i2c

Linter results for project: no errors or warnings

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x64_spi

Linter results for project: no errors or warnings

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

Linter results for projects: 1 ERRORS, 2 WARNINGS

@github-actions
Copy link
Contributor

Thanks for your interest in contributing to the Arduino Library Manager index @sam-peach
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 Aug 30, 2022

Hello @sam-peach. I see you have fixed the error reported by the bot. However, Library Manager works exclusively from Git tags, so the bot won't be able to see the fix you made until you create a new release or tag in the library repository.

If you look at the repository contents at the latest tag, you can see that the version the bot is checking still has the problem:

https://github.com/sam-peach/Adafruit_SSD1306_EMULATOR/blob/2.5.1/library.properties#L1

name=Adafruit SSD1306

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

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.

Regards, Per

@sam-peach sam-peach closed this Aug 30, 2022
@per1234 per1234 self-assigned this Aug 30, 2022
@sam-peach sam-peach reopened this Aug 30, 2022
@sam-peach
Copy link
Contributor Author

@ArduinoBot

@github-actions
Copy link
Contributor

Hello! I'm checking your submission again.

@github-actions
Copy link
Contributor

Arduino Lint has suggestions for possible improvements to https://github.com/sam-peach/Adafruit_SSD1306_EMULATOR:

Linting library in Adafruit_SSD1306_EMULATOR
WARNING: library.properties name value Adafruit SSD1306 EMULATOR is longer than the recommended length of 16 characters.
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP010)                                                                                                   
WARNING: library.properties name Adafruit SSD1306 EMULATOR 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: The library.properties paragraph field repeats the sentence field. These are displayed together so redundancy  
         is not needed.                                                                                                 
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format         
         (Rule LP036)                                                                                                   

Linter results for project: 0 ERRORS, 3 WARNINGS

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x32_i2c

Linter results for project: no errors or warnings

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

Linting sketch in Adafruit_SSD1306_EMULATOR/examples/ssd1306_128x64_i2c

Linter results for project: no errors or warnings

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

Linter results for projects: 0 ERRORS, 3 WARNINGS

@github-actions github-actions bot merged commit 4e0e4c7 into arduino:main Aug 30, 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/sam-peach/Adafruit_SSD1306_EMULATOR/

github-actions bot pushed a commit that referenced this pull request Aug 30, 2022
@sam-peach
Copy link
Contributor Author

@per1234 thank you so much for the help! All set now :)

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