CI/CD Pipeline Documentation: Hooked AI Video Editor

Overview

This document outlines the Continuous Integration and Continuous Deployment (CI/CD) pipeline for the Hooked AI Video Editor project. The pipeline automates the build, test, and deployment processes for the backend video editing service.

CI/CD Pipeline Flow Diagram

graph TD
    A[Developer pushes code] -->|to prod/testing/cst branch| B(GitHub repository)
    B -->|Triggers| C{GitHub Actions}
    C -->|1. Setup| D[Prepare environment]
    D -->|2. Configure| E[Create .env file]
    E -->|3. Build| F[Build Docker image]
    F -->|4. Tag| G[Tag image based on branch]
    G -->|5. Push| H[Push to DockerHub]
    H -->|6. Cleanup| I[Remove .env file]
    I -->|7. Notify| J[Send notifications]
    H -.->|Trigger| K[RunPod template]
    K -->|Fetch latest image| L[Update serverless worker]
    
    subgraph "GitHub Actions Workflow"
    C
    D
    E
    F
    G
    H
    I
    J
    end
    
    subgraph "RunPod Integration"
    K
    L
    end

    classDef default fill:#2c3e50,stroke:#ecf0f1,stroke-width:2px,color:#ecf0f1;
    classDef highlight fill:#34495e,stroke:#3498db,stroke-width:2px,color:#3498db;
    classDef action fill:#2980b9,stroke:#ecf0f1,stroke-width:2px,color:#ecf0f1;
    classDef trigger fill:#c0392b,stroke:#ecf0f1,stroke-width:2px,color:#ecf0f1;
    class A,B default;
    class C,D,E,F,G,H,I,J action;
    class K,L highlight;
    class A trigger;

    style C fill:#16a085,stroke:#ecf0f1,stroke-width:2px,color:#ecf0f1

Pipeline Trigger Events

The CI/CD pipeline is triggered by the following events:

• Push to prod, testing, or cst (custom subtitle) branches
• Closure of a pull request (when merged)

Environment Setup

• Runner: Ubuntu Latest
• Tools:
  • Docker
  • Docker Compose (v2.5.0)
  • Docker Buildx

Pipeline Stages

1. Code Checkout

• Uses: actions/checkout@v2

2. Environment Preparation

• Set up Docker Buildx
• Install Docker Compose
• Login to DockerHub using secure credentials

3. Configuration

• Generate timestamp (IST) for versioning
• Create .env file with necessary secrets and configuration