An orb to make it easy to detect which operating system (OS) and version your orb and/or CircleCI config is running on.
Notes: This orb is the spiritual successor to the deprecated OS Detect orb by CircleCI.
CircleCI Support
| Executor/OS | Supported? | Shell |
|---|---|---|
| Docker/Ubuntu | yes | Bash |
| Docker/Debian | yes | Bash |
| Docker/Alpine | yes | Bash |
| macOS | yes | Bash |
| machine/Ubuntu | yes | Bash |
Example use as well as a list of available executors, commands, and jobs are available on this orb's registry page.
| Variables | Description |
|---|---|
| $OSD_FAMILY | The OS family. For example, linux or darwin |
| $OSD_ID | The OS slug name. For example, ubuntu, alpine or macos. |
| $OSD_VERSION | The OS version number, as advertised. For example, 18.04 for Ubuntu or 10.9 for macOS. |
| $SUDO | Contains the string "sudo" when the current user is not root and the sudo binary is available. Prefix this with your commands. |
Version 1 of this orb (as well as the v0 releases) will maintain compatibility with the original OS Detect orb. For people transitioning from the old orb to this one, this will make that process easier.
When v2 lands later in 2023, it will be a breaking change that moves this orb to a more advanced and useful future.
CircleCI Orb Registry Page - The official registry page for this orb will include all versions, executors, commands, and have described the jobs.
CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.
I welcome issues to and pull requests against this repository! For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.
New versions of this orb are published by pushing a SemVer git tag by Ricardo N Feliciano.
This project is licensed under the MIT License - read LICENSE file for details.