How can I make my orbs private?

Private orbs are available for preview exclusively to developers on our Scale Plan. Administrators can create, publish, and maintain their private orbs. For more details on how to start privately sharing configuration across multiple projects within your organization, please refer to our orbs documentation: 

 

While private orbs are not supported for all users at this time, orb publishers can unlist their orbs from Orb Registry search results by using our CLI (See the documentation of the relevant command here: https://circleci-public.github.io/circleci-cli/circleci_orb_unlist.html). Unlisted orbs can be listed in the orb registry again with the same CLI command. Only org admins can unlist/list orbs. Note that unlisting an orb does not affect its ability to be referenced by name in builds or for its source to be viewed. 

 

Making a public orb private : 

A public orb cannot be deleted but it can be unlisted. You will not need to make any changes to your orb repository. You will need to re-publish your orb as a new private orb. Because the orb name is already taken, you will not be able to publish the new (private) orb under the same name. To do this, we recommend using the Orb Development Kit. When using the Orb Development Kit you will need to do the following to make an Orb Private:

  • Initialize and create the new private orb from the CLI (with the private flag).
    circleci orb init /path/to/myProject-orb --private
  • Change your existing config.yml file that automatically published the orb to replace the old orb name with the new orb name.
Was this article helpful?
5 out of 24 found this helpful

Comments

0 comments

Article is closed for comments.