Skip to content

Allow deprecation of Library Manager libraries #1001

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

Open
MHotchin opened this issue Apr 25, 2020 · 1 comment
Open

Allow deprecation of Library Manager libraries #1001

MHotchin opened this issue Apr 25, 2020 · 1 comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@MHotchin
Copy link

A library I wrote has been rolled up into another library. Is there a way to 'deprecate' my library, so that users are pointed towards the newest version of the other library?

In my case, the OLD (to be deprecated) library is:
https://github.com/MHotchin/Waveshare4InchTftShield

It has been merged into:
https://github.com/ImpulseAdventure/Waveshare_ILI9486

@per1234 per1234 changed the title [Library Manager] How do I deprecate an existing library? Allow deprecation of Library Manager libraries Oct 2, 2020
@per1234
Copy link
Contributor

per1234 commented Oct 2, 2020

I suggest making a final release of the deprecated library which does two things:

  • Adds a deprecation notice to the sentence value in library.properties
  • Adds a #warning to the code that displays a deprecation notice in the console when the library is compiled (assuming the user has warnings enabled)

Although it doesn't apply to your case, it is worth mentioning for the benefit of others that if it's only a matter of wanting to change the name of a repository or transfer it to another user, GitHub has features to allow this to be done with the existing repository, rather than needing to create a copy. When you do it that way, GitHub sets up a redirect from the original URL to the new repository. This could eliminate the need to do a deprecation in these cases. Even though there is the redirect, it's probably a good idea to open an issue here requesting the URL in the Library Manager index be updated.


It would be interesting to consider how Library Manager could provide formal support for deprecation, I suppose this would require the addition of a field in library.properties

I think the process I described above is reasonably effective. The primary flaw is that compiler warnings are disabled by default.

@per1234 per1234 transferred this issue from arduino/Arduino Oct 2, 2020
@per1234 per1234 added the type: enhancement Proposed improvement label Oct 2, 2020
@per1234 per1234 reopened this Mar 30, 2021
@per1234 per1234 added the topic: code Related to content of the project itself label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants