The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

CircleCI

Next ►
►

CircleCI is a popular CI/CD tool that automates the software development process, allowing teams to build, test, and deploy code with confidence. This section will cover the basics of CircleCI, its setup, and how to create and manage CI/CD pipelines using CircleCI.

Table of Contents

  1. Introduction to CircleCI
  2. Setting Up CircleCI
  3. Creating a Basic Pipeline
  4. Advanced Pipeline Configuration
  5. Practical Exercises
  6. Summary

Introduction to CircleCI

Key Concepts

  • Continuous Integration (CI): Automates the process of integrating code changes from multiple contributors into a shared repository.
  • Continuous Deployment (CD): Automates the deployment of code to production environments.
  • Pipeline: A series of automated processes that include building, testing, and deploying code.

Benefits of CircleCI

  • Speed: Parallel job execution and caching mechanisms speed up the CI/CD process.
  • Scalability: Easily scales with your project needs.
  • Flexibility: Supports various programming languages and frameworks.
  • Integration: Seamlessly integrates with popular version control systems like GitHub and Bitbucket.

Setting Up CircleCI

Prerequisites

  • A GitHub or Bitbucket account.
  • A repository with a project you want to integrate with CircleCI.

Steps to Set Up CircleCI

  1. Sign Up: Go to CircleCI and sign up using your GitHub or Bitbucket account.
  2. Add a Project:
    • Navigate to the CircleCI dashboard.
    • Click on "Add Projects."
    • Select the repository you want to integrate.
    • Click on "Set Up Project."
  3. Create a Configuration File:
    • In the root directory of your repository, create a folder named .circleci.
    • Inside the .circleci folder, create a file named config.yml.

Example Configuration File

version: 2.1

jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Install Dependencies
          command: |
            python -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt
      - run:
          name: Run Tests
          command: |
            . venv/bin/activate
            pytest

workflows:
  version: 2
  build_and_test:
    jobs:
      - build

Explanation

  • version: Specifies the CircleCI configuration version.
  • jobs: Defines individual tasks (e.g., build, test).
    • docker: Specifies the Docker image to use.
    • steps: Lists the steps to execute within the job.
      • checkout: Checks out the code from the repository.
      • run: Executes shell commands.
  • workflows: Defines the sequence of jobs to be executed.

Creating a Basic Pipeline

Steps to Create a Basic Pipeline

  1. Define Jobs: Create jobs for building, testing, and deploying your code.
  2. Configure Workflows: Set up workflows to specify the order of job execution.

Example: Basic Pipeline Configuration

version: 2.1

jobs:
  build:
    docker:
      - image: circleci/node:14
    steps:
      - checkout
      - run:
          name: Install Dependencies
          command: npm install
      - run:
          name: Run Tests
          command: npm test

  deploy:
    docker:
      - image: circleci/node:14
    steps:
      - checkout
      - run:
          name: Deploy to Production
          command: npm run deploy

workflows:
  version: 2
  build_and_deploy:
    jobs:
      - build
      - deploy:
          requires:
            - build

Explanation

  • build job: Installs dependencies and runs tests.
  • deploy job: Deploys the application to production.
  • workflows: Ensures the deploy job runs only after the build job is successful.

Advanced Pipeline Configuration

Parallelism

  • Parallel Jobs: Run multiple jobs in parallel to speed up the CI/CD process.
jobs:
  test:
    docker:
      - image: circleci/python:3.8
    parallelism: 4
    steps:
      - checkout
      - run:
          name: Run Tests
          command: |
            . venv/bin/activate
            pytest --maxfail=1 --disable-warnings -n 4

Caching

  • Caching Dependencies: Cache dependencies to avoid re-installing them in every build.
jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - restore_cache:
          keys:
            - v1-dependencies-{{ checksum "requirements.txt" }}
      - run:
          name: Install Dependencies
          command: |
            python -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt
      - save_cache:
          paths:
            - ./venv
          key: v1-dependencies-{{ checksum "requirements.txt" }}

Practical Exercises

Exercise 1: Setting Up a Basic Pipeline

  1. Create a .circleci/config.yml file in your repository.
  2. Define a job to build and test your application.
  3. Configure a workflow to run the job.

Solution:

version: 2.1

jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Install Dependencies
          command: |
            python -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt
      - run:
          name: Run Tests
          command: |
            . venv/bin/activate
            pytest

workflows:
  version: 2
  build_and_test:
    jobs:
      - build

Exercise 2: Adding a Deployment Step

  1. Extend the existing pipeline to include a deployment step.
  2. Ensure the deployment step runs only after the build and test steps are successful.

Solution:

version: 2.1

jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Install Dependencies
          command: |
            python -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt
      - run:
          name: Run Tests
          command: |
            . venv/bin/activate
            pytest

  deploy:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Deploy to Production
          command: |
            . venv/bin/activate
            ./deploy.sh

workflows:
  version: 2
  build_and_deploy:
    jobs:
      - build
      - deploy:
          requires:
            - build

Summary

In this section, we covered the basics of CircleCI, including setting up a project, creating a basic pipeline, and configuring advanced pipeline features such as parallelism and caching. We also provided practical exercises to help reinforce the concepts learned. CircleCI is a powerful tool that can significantly streamline your CI/CD processes, making it easier to build, test, and deploy your applications efficiently.

◄ Previous
◄
Next ►
►
The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved