arduino / library-registry

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

Update repositories.txt #1916

Closed galarb closed 1 year ago

github-actions[bot] commented 1 year ago

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

: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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

Arduino Lint has suggestions for possible improvements to https://github.com/galarb/clicli:

Linting library in clicli
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: 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 1 year ago

:x: 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.

per1234 commented 1 year ago

Hello @galarb. The reason the bot is unable to recognize the name field from your library.properties metadata file is because you have used the "UTF-8 BOM" character encoding in the file. This odd encoding adds a "BOM" character to the start of the file. So instead of this:

name=clicli

Your file actually is this:

<BOM>name=clicli

Hello @galarb. 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: Library is missing a library.properties metadata file.

I'll provide instructions for how you can fix the problem:

Remove BOM character

Depending on which text editor you are using on your computer, it might be more complicated to change the file encoding. The GitHub web interface makes it quite easy, so I'll provide instructions using it.

  1. Open this page in your web browser: https://github.com/galarb/clicli/blob/master/library.properties.txt
  2. Click the pencil icon on the toolbar ("Edit this file").
  3. Look in the field containing the file contents. you will see a little red dot before name=clicli. This dot symbolizes the BOM character: image
  4. Click on the field containing the containing the file contents.
  5. Place the cursor after the red dot character.
  6. Press the Backspace key to delete the red dot character from the file.
  7. Scroll down to the bottom of the page.
  8. Click the Commit changes button.

You will now have the correct filename.

Make tag

Now 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.

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

Trigger the checks again

Once you have done that, simply mention @<!---->Arduino<!---->Bot 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.

Fix your editor software and existing files

You will likely have confusing problems like this over and over again as long as the text editor software on your computer is still configured to use UTF-8 BOM encoding. There is never any reason to use this encoding. Any good text editor will have an option to set the default encoding. Set it to "UTF-8".

If your text editor does not offer this option, get a good one. I recommend VS Code, but there are many options.

Even after you have configured the default character encoding in your editor, all the files you created with the bad setting will continue to have UTF-8 BOM encoding. You should open all these files and convert their encoding to UTF-8. Any good text editor will allow you do this easily.


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

Regards, Per


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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

A problem was found with your submission https://github.com/galarb/clicli

:x: ERROR: library.properties is missing a name field.

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 @galarb 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

galarb 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

Arduino Lint has suggestions for possible improvements to https://github.com/galarb/clicli:

Linting library in clicli
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: 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

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