CircleCI Ideas

Ability to deprecate a published Orb indicating to the public that the Orb is no longer maintained

I recently refactored an Orb to be more generic, which led me to use a new name. The original Orb still exists on the Orb Registry.


I would like to communicate to the public that the original Orb is no longer supported.


The benefits to the public include:

- Informing users of the original Orb that they are consuming an un-maintained Orb.

- Preventing users from becoming dependent on an un-maintained Orb.

- Mitigate the risk of being associated with an Orb that I no longer maintain (Avoiding support requests for an Orb that I no longer maintain).

  • Avatar32.5fb70cce7410889e661286fd7f1897de Guest
  • Nov 30 2018
  • Taking votes
  • Attach files
  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    November 30, 2018 23:55

    This is a good idea -- we do now have the ability to hide an orb, so you can at least stop having any new adopters of it. We haven't (yet) exposed that to the user, but if you let us know which orb you want to hide we can do it on our side. The more general solution on top of that will also come from some way to have orb revision annotations available in the registry.

  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    December 03, 2018 16:17

    Nathan, I went ahead and published a version `2.0.0` of my Orb containing no functionality, along with a description indicating that the Orb is no longer maintained -

  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    December 04, 2018 06:27

    We went ahead and hid that orb. This is obviously not the "right" place to have had this exchange, which indicates we will want a better place to make such requests.