Add Blues Notecard Environment Variable Manager

[zfields]

No description provided.

[github-actions]

❌ ERROR: Arduino Lint found errors with https://github.com/blues/notecard-env-var-manager:

Linting library in notecard-env-var-manager
WARNING: Git submodule detected. Library Manager installations and installations from GitHub's "Download ZIP" will only 
         contain an empty folder in place of the submodule. (Rule LS004)                                                
ERROR: Symlink(s) found. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library     
       Manager index:                                                                                                   
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.c                                               
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.h                                               
       (Rule LS005)                                                                                                     
INFO: No header file found matching library name (Blues_Notecard_Environment_Variable_Manager.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 value Blues Notecard Environment Variable Manager 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 Blues Notecard Environment Variable Manager 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)                                                                                                   

Linter results for project: 1 ERRORS, 3 WARNINGS

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

Linting sketch in notecard-env-var-manager/examples/arduino

Linter results for project: no errors or warnings

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

Linter results for projects: 1 ERRORS, 3 WARNINGS

[github-actions]

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

Hello @zfields. 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: Symlink(s) found. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library     
       Manager index:                                                                                                   
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.c                                               
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.h                                               

If you have any questions or problems while following the instructions to resolve the problem, 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.

[zfields]

Hi @per1234, thanks for your help in ciphering the message!

The folder in question is for an unrelated zephyr implementation.

Is it possible to indicate in the library.properties file that we would like to ignore a specific subfolder, or is there a common workaround for this?

[per1234]

Is it possible to indicate in the library.properties file that we would like to ignore a specific subfolder

At this time, the entire contents of the repository are included in the archive generated by the Library Manager system for installation on the user's machine.

There is a request for a feature that would allow something like this here: arduino/libraries-repository-engine#59

is there a common workaround for this?

You will need to ensure the tagged releases do not contain any symlinks. One option would be to move the Zephyr example to a dedicated repository and then incorporate the library files into the example project by adding the library repository to the Zephyr example repository as a Git submodule (as I see is already being done for some other libraries).

[zfields]

So if we were to create a samples/ folder and move zephyr/ to that new folder in our repository.

What would be required to resubmit the CI jobs (checks)?

[per1234]

So if we were to create a samples/ folder and move zephyr/ to that new folder in our repository.

Sorry, no. You are not allowed to have symlinks anywhere in your repository. You must remove them from the library repository entirely.

What would be required to resubmit the CI jobs (checks)?

Just add a comment here mentioning @ArduinoBot to trigger it to run the automated checks again. Once 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

[zfields]

Hello @ArduinoBot!

We are ready to try again!

[github-actions]

Hello! I'm checking your submission again.

[github-actions]

❌ ERROR: Arduino Lint found errors with https://github.com/blues/notecard-env-var-manager:

Linting library in notecard-env-var-manager
WARNING: Git submodule detected. Library Manager installations and installations from GitHub's "Download ZIP" will only 
         contain an empty folder in place of the submodule. (Rule LS004)                                                
ERROR: Symlink(s) found. Symlinks cause difficulties for Windows users. These block addition to the Arduino Library     
       Manager index:                                                                                                   
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.c                                               
         notecard-env-var-manager/examples/zephyr/NotecardEnvVarManager.h                                               
       (Rule LS005)                                                                                                     
INFO: No header file found matching library name (Blues_Notecard_Environment_Variable_Manager.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 value Blues Notecard Environment Variable Manager 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 Blues Notecard Environment Variable Manager 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)                                                                                                   

Linter results for project: 1 ERRORS, 3 WARNINGS

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

Linting sketch in notecard-env-var-manager/examples/arduino

Linter results for project: no errors or warnings

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

Linter results for projects: 1 ERRORS, 3 WARNINGS

[github-actions]

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

Hello @zfields. 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/blues/notecard-env-var-manager/tree/v1.0.0/examples/zephyr

❗ 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

[zfields]

Okay @ArduinoBot, I have a new VERSION for you to test! 👍

[github-actions]

Hello! I'm checking your submission again.

[github-actions]

Arduino Lint has suggestions for possible improvements to https://github.com/blues/notecard-env-var-manager:

Linting library in notecard-env-var-manager
WARNING: Git submodule detected. Library Manager installations and installations from GitHub's "Download ZIP" will only 
         contain an empty folder in place of the submodule. (Rule LS004)                                                
INFO: No header file found matching library name (Blues_Notecard_Environment_Variable_Manager.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 value Blues Notecard Environment Variable Manager 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 Blues Notecard Environment Variable Manager 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)                                                                                                   

Linter results for project: 0 ERRORS, 3 WARNINGS

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

Linting sketch in notecard-env-var-manager/examples/arduino

Linter results for project: no errors or warnings

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

Linter results for projects: 0 ERRORS, 3 WARNINGS

[github-actions]

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/blues/notecard-env-var-manager/