CircleCI Config Generator

What is config.yml?

CircleCI relies on a configuration file named config.yml placed in a .circleci directory at the root of your project. This file instructs the CircleCI platform on what jobs to run, how to run them, and in what order.

Key Components

#

Executors

An executor defines the underlying technology or environment in which the steps of a job will be run. CircleCI supports several executors:

Docker: Runs jobs in Docker containers. (Highly recommended for speed and reproducibility).

Machine: Runs jobs in a dedicated Linux or Windows virtual machine.

MacOS: Runs jobs in a macOS environment (useful for iOS builds).

#

Jobs and Steps

Jobs represent a collection of steps. A step is an executable command, like running npm install or executing a bash script.

Jobs must have a designated executor.

#

Workflows

Workflows orchestrate the execution of jobs. They allow you to define:

Sequential execution (Job B requires Job A).

Parallel execution (Job A and Job B run simultaneously).

Branch filtering (Only run Job C on the main branch).

Manual approvals (Wait for human input before deploying).

#

Orbs

Orbs are reusable packages of CircleCI configuration that you can share across projects. Instead of writing 100 lines of bash to deploy to AWS, you can import the AWS orb and use a single command.

Best Practices

Use Contexts: Contexts allow you to secure and share environment variables across projects. Do not hardcode secrets into the config.yml.

Persist to Workspace: Use workspaces to move files (like compiled binaries or node_modules) between jobs in a workflow, rather than regenerating them.