Functions FAQ Beta
FAQs
What is the difference between functions and orbs?
Orbs package reusable configuration. Functions are programs that run as steps inside your jobs. For a side-by-side comparison, refer to the Functions and Orbs section.
Can I use functions and orbs in the same configuration?
Yes. Declare orbs under orbs and functions under functions in the same configuration file. Give each function an alias that does not clash with an orb name.
Which version of a function do I use?
Use the latest version unless you need a specific one. To see every published version, run circleci function get <name>. To declare a function at its latest version, run circleci function add <name>.
Why do I need to pin an exact version?
An exact version means every run uses the same function, until you choose to update it. Partial versions such as v0 and labels such as latest fail validation. To move to a newer release, run circleci function update <alias>.
Why does my configuration fail validation after I change a function version?
CircleCI checks each function step against the version you pin. If the new version renamed or removed a flag or command that your step uses, validation fails and the error lists the valid flags or commands. Update the step to match, then run circleci config validate to check it.
How do I see the flags a function accepts?
Read the function’s README, linked from the Functions Catalog, or run circleci function get <name>.
Do I need to add cache steps when I use a function?
No. Functions that support caching manage their own caches. Refer to How Functions Run.
See also
-
Refer to Functions Overview for a starting point on using functions.
-
Refer to Functions Concepts for high-level information about CircleCI functions.