Custom Library change Repo URL and Name

Projects Libraries
1

Hi,

I have 6 custom libraries that I need to change the repository URL and name for. I'm moving from bitbucket to github and rebranding the libraries.

I have found a way to change the name but this needs to point to the old repo URL.

Does anyone have any advice on the best approach? I'm thinking it may be easier to delete the old libraries and add new ones with the new name and URL.

2

Hi @reefwing. You can find the instructions for changing the library's URL here:

https://github.com/arduino/library-registry#changing-the-url-of-a-library-already-in-library-manager

Please let me know if you have any questions.

Per

3

Thanks for the quick reply Per - do you have an opinion on what order I need to change (i.e., name first then URL) or vice versa? Would it be easier to delete the libraries and then add them back?

4

I think it is best to change the URLs, then the name. But you don't need to wait for the URL change requests to be completed before you submit the name change requests. Just submit all the requests to the arduino/library-registry repo.

Since you are changing the name, that will also work.

The one thing you should be aware of is that requests for url change, name change, or removal are all handled manually and it can take up to two weeks for the maintainer to get around to doing that. Submissions are handled automatically so it only takes a day at most between submission and when the library becomes available in Library Manager. So if you submit the removal request and also submit the new libraries at the same time, there will be a period where both the old libraries and the new libraries are in Library Manager. That is not a problem for Library Manager because they are considered separate libraries since they have different names, but whether it is how you want to manage the transition is up to you.

If you wanted to avoid that period of both variants of the libraries being in Library Manager simultaneously, you would need to follow this sequence:

  1. Submit requests to delete the libraries.
  2. Wait for maintainer to handle the requests (this can take up to 2 weeks).
  3. Submit the libraries again with the new URLs (these requests are handled automatically so it will take less than a day).

That is slower than the equivalent alternative:

  1. Submit requests for URL and name updates.
  2. Wait for maintainer to handle the requests (this can take up to 2 weeks).
5

Thanks for all your help and the thoughtful reply - much appreciated.

6

You are welcome. I'm glad if I was able to be of assistance. Thanks for all your valuable libraries!

Per

7

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.