This document describes various questions and technical issues that you may find helpful when working with orbs.
Can orbs be made private?
Private orbs are available on any of our current plans.
What is the difference between commands and jobs?
Commands contain one or many steps, which contain the logic of the orb. Commands generally execute some shell code (bash).
Can orbs be used on a private installation of CircleCI server?
Orbs can be used with installations of CircleCI server v3. For information on importing and using orbs for server, see the CircleCI Server v3.x orbs guide.
Orbs are not available on installations of server v2.19.x, however, if you process your config prior to committing, orbs can be translated and used. Follow this guide on using git pre-commit hooks to use orbs on server.
How can I report a bug or issue with a public orb?
All public orbs are open source projects. Issues, bug reports, or even pull requests can be made against the orb’s git repository. Public orb authors may opt to include a link to the git repo on the orb registry. If the git repo link is unavailable, contact support and we will attempt to contact the author. Alternatively, consider forking the orb and publishing your own version.
How do I use the latest version of an orb?
Orbs use semantic versioning, meaning if you set the major version (example:
3), you will receive all minor and patch updates, where if you statically set the version (example:
3.0.0), no updates will apply, this is the most deterministic and recommended method.
| NOT RECOMMENDED - It is possible to use |
Orbs concepts for high-level information about CircleCI orbs.
Orb publishing process for information about orbs that you may use in your workflows and jobs.
Orbs reference for examples of reusable orbs, commands, parameters, and executors.
Help make this document better
This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.
You can also visit our support site to find support articles, community forums, and training resources.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.