docker / buildx

CI/CD Automation Scripts

This section outlines the CI/CD automation scripts integrated within the project, detailing how they are utilized for building, testing, and deploying applications.

Overview

The CI/CD process leverages GitHub Actions located in the .github/workflows directory. It’s structured to automate various tasks, including building Docker images, running tests, and validating code quality.

Existing CI/CD Scripts

  1. GitHub Actions workflows

    • Located in .github/workflows/, the following YAML files define automated processes that are triggered through various GitHub events:

      • build.yml: Automates the building of Docker images.
      • codeql.yml: Runs security analysis on the codebase using CodeQL.
      • e2e.yml: Executes end-to-end tests.
      • labeler.yml: Automatically applies labels to pull requests.
      • validate.yml: Ensures that code adheres to the style guides and conventions.

Step-by-Step CI/CD Automation Guide

1. Build Automation

The build.yml file automates the building of the project using the Dockerfile provided in the root directory. Below is an excerpt of the build workflow:

name: Build Docker Image

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v1

    - name: Build and push Docker image
      uses: docker/build-push-action@v2
      with:
        context: .
        file: Dockerfile
        push: true
        tags: your-dockerhub-username/your-image:latest

This script initiates the automation process upon a push to the main branch, checking out the code, setting up Docker Buildx, and then building the Docker image before pushing it to Docker Hub.

2. Testing Automation

Testing is handled through various stages in build.yml and the availability of specific targets in the Makefile, particularly the test, test-integration, and test-unit targets. For example, running unit tests can be defined as follows:

  test:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Go
      uses: actions/setup-go@v2
      with:
        go-version: '1.23'

    - name: Run tests
      run: make test

This segment ensures that tests are executed anytime there’s a code change, maintaining the integrity of the application.

3. Validate Code Quality

The validate.yml workflow governs the validation process to ensure conformity to code quality standards:

name: Validate Code

on:
  pull_request:
    branches:
      - main

jobs:
  validate:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Run Linter
      run: make lint

The above process applies lint checks to the codebase whenever a pull request is made, ensuring that all contributions follow the project’s coding standards.

Makefile Targets

The Makefile offers several targets to facilitate CI/CD processes. Key targets include:

  • make test: Executes unit tests.
  • make test-integration: Runs integration tests.
  • make validate-all: Validates the entire codebase.

Example interaction:

make test        # To run unit tests
make validate-all # To validate the code style and quality

Next Steps for Unset CI/CD Environments

If CI/CD is not yet set up in the project, consider implementing the following steps:

  1. Set Up Version Control Hooks: Configure webhooks for GitHub to trigger CI/CD processes on specific events.

  2. Define Workflows: Create workflow YAML files in the .github/workflows directory that encompass build, test, and validation processes.

  3. Establish Docker Support: Ensure that Docker is integrated into the workflow for building and deploying applications.

  4. Documentation and Monitoring: Regularly update documentation related to CI/CD processes and monitor the effectiveness of the pipelines.

Implementing these steps will foster automation throughout the development lifecycle, yielding a more efficient working environment.

Source: Project directory structure and existing workflows.