CI/CD pipeline setup

[reboottime]

The Process

CI Process

For any pull request (maybe more strict on push request) on any branches, run following steps

• lint code
• build code
• test code
  • unit test
  • integration test
  • end 2 end test
    

CD Process

• For any push event on ['dev', 'sandbox', 'main'] branch
• Run CI
• Run deploy

[reboottime]

Configuration Example

name: CI/CD

on:
  push:
    branches:
      - dev
      - sandbox
      - main
  pull_request:
    branches:
      - '**'

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm install
      - name: Run linter
        run: npm run lint

  build:
    runs-on: ubuntu-latest
    needs: lint
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm install
      - name: Build the code
        run: npm run build

  unit-test:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm install
      - name: Run unit tests
        run: npm run test:unit

  integration-test:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm install
      - name: Run integration tests
        run: npm run test:integration

  e2e-test:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm install
      - name: Run end-to-end tests
        run: npm run test:e2e

  deploy:
    runs-on: ubuntu-latest
    needs: [unit-test, integration-test, e2e-test]
    if: github.event_name == 'push' && (github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/sandbox' || github.ref == 'refs/heads/main')
    steps:
      - uses: actions/checkout@v4
      - name: Deploy to environment
        run: |
          # Add your deployment steps here based on the branch
          if [ "${{ github.ref }}" == "refs/heads/dev" ]; then
            # Deploy to dev environment
            echo "Deploying to dev environment..."
          elif [ "${{ github.ref }}" == "refs/heads/sandbox" ]; then
            # Deploy to sandbox environment
            echo "Deploying to sandbox environment..."
          elif [ "${{ github.ref }}" == "refs/heads/main" ]; then
            # Deploy to production environment
            echo "Deploying to production environment..."
          fi