Skip to content
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

Removing deprecated library #5411

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Removing deprecated library #5411

wants to merge 18 commits into from

Conversation

maker-zone
Copy link
Contributor

The same functionality of sharing signatures between multiple libraries to make them interchangeable can be achieved without using an interface, so this library was deprecated to avoid wasting space on an arduino.

@maker-zone maker-zone marked this pull request as ready for review November 13, 2024 00:18
Copy link
Contributor

Hi @maker-zone.
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

@github-actions github-actions bot added the topic: removal Remove library from the list label Nov 13, 2024
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @maker-zone . 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 close this issue 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

@per1234 per1234 added the status: pending backend Depends on backend maintenance operations label Nov 13, 2024
Copy link
Contributor

Hi @maker-zone.
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

@github-actions github-actions bot added topic: modification Change existing list entry and removed topic: removal Remove library from the list status: pending backend Depends on backend maintenance operations labels Nov 20, 2024
@github-actions github-actions bot removed the request for review from per1234 November 20, 2024 23:28
Copy link
Contributor

ERROR: Arduino Lint found errors with https://github.com/UltiBlox/SerialCommands:

Linting library in SerialCommands
INFO: No header file found matching library name (UltiBlox-SerialCommands.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 UltiBlox-SerialCommands is longer than the recommended length of 16 characters.
         See: https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format       
         (Rule LP010)                                                                                                 
ERROR: Library name UltiBlox-SerialCommands 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: 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: 1 ERRORS, 2 WARNINGS

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

Linting sketch in SerialCommands/examples/BasicUsage

Linter results for project: no errors or warnings

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

Linter results for projects: 1 ERRORS, 2 WARNINGS

Copy link
Contributor

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

@maker-zone
Copy link
Contributor Author

maker-zone commented Nov 21, 2024

I removed one library
UltiBlox DisplayValueCommon
...and just now added another
UltiBlox-SerialCommands
It looks like the system is thinking I just renamed it.
What's the best way to resolve this? Should I just wait until the previous removal is completed then this addition should go through?

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maker-zone please submit a separate pull request for each distinct request.

You can have multiple open pull requests by creating a separate branch in your fork for the specific changes you want to propose, then submitting a pull request from that branch.

In order to facilitate this workflow, you should never use the main branch of your fork to stage changes for a pull request. Instead, the main branch should be kept in sync with the parent repository's branch, so it can be used as the base for your pull request branches.

Please remove the change you made to this pull request so that it only contains the change of removing https://github.com/UltiBlox/DisplayValueCommon.

@per1234 per1234 added status: changes requested Changes to PR are required before merge topic: removal Remove library from the list and removed topic: modification Change existing list entry labels Nov 21, 2024
@github-actions github-actions bot removed the status: changes requested Changes to PR are required before merge label Nov 23, 2024
Copy link
Contributor

Hi @maker-zone.
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

@maker-zone
Copy link
Contributor Author

Ah I think I understand my mistake now.
I've removed that addition from this. I hadn't intended to include it in the same PR but didn't realise that it would get included automatically.
From now on I'll use branches other than main for each change.

Copy link
Contributor

Hi @maker-zone.
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

@per1234 per1234 added the status: pending backend Depends on backend maintenance operations label Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: pending backend Depends on backend maintenance operations topic: removal Remove library from the list
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants