CI - 100-hours-a-week/9-team-Devths-WIKI GitHub Wiki

💡 CI (Continuous Integration)이란? 여러 개발자가 변경한 코드를 주기적으로 통합하고, 빌드 및 테스트 자동화를 통해 품질을 유지하는 개발 방법론입니다.

1. 코드 병합 과정에서의 한계

• 각 팀은 독립 레포를 사용하고 있으나, 공통된 릴리즈 일정을 맞추기 위해 각자의 develop 브랜치에서 빈번히 병합 작업을 수행함.
• PR 시점에만 수동 리뷰와 테스트를 진행하다 보니, 린트 오류나 테스트 실패가 뒤늦게 발견되어 리뷰 병목과 일정 지연이 발생하는 사례 존재.

2. 배포 빈도의 증가

• 서비스를 빠르게 개선하고 기능을 검증하기 위해 배포 횟수가 증가함.
• 반복적이고 수동적인 배포 과정에서는 오류가 누적되고, 배포 속도가 느려 사용자 피드백 반영이 늦어짐.
• CI 파이프라인을 통해 자동 빌드와 테스트를 수행하면, 빠른 배포가 가능하고 개발 생산성을 높일 수 있음.

3. 코드 품질 관리 체계의 미흡

• 각 레포별로 테스트 정책이나 린트 규칙이 정립되지 않아, 일부 브랜치에서는 테스트가 누락되거나 린트가 무시된 채 병합되는 사례 발생.
• 현재 main 브랜치 병합 시점에도 코드 정적 분석, 테스트 자동화가 충분히 적용되지 않아, 운영 반영 직전에 오류가 발견되는 경우가 발생함.
• 팀원 간 협업 경험이 다르다 보니 테스트 코드 작성 및 실행 습관이 부족하여 코드 퀄리티에 대한 신뢰성 확보가 어려움.

4. 운영 환경과 개발 환경의 분리 미흡

• 기존에는 GitHub Flow 로서, main과 feat 만으로 운영하여 훨씬 간단하지만 빠르게 수정 배포할 수 있는 전략을 사용함.
• 하지만 운영 서버와 개발 서버가 명확히 분리되어 있지 않아, 테스트 과정에서 발생한 문제나 버그가 서비스 전체 가용성에 직접적인 영향을 미칠 위험이 있다고 판단함.

• Git Flow 기반으로 feature → develop → Release(Staging) → main 순으로 PR과 머지를 진행
• 각 단계에서 Lint → Static Analysis → Unit/Integration Test → Build → Artifact 저장 → Discord 알림으로 CI를 진행

• 사용하는 플랫폼 : Github Actions
• 환경 : AWS EC2 인스턴스 (기존 2개 / 상황에 따라서 3개)
• 형상 관리 : GItHub
• 배포 대상: 프론트엔드, 백엔드, AI 서버, DB 전부 단일 인스턴스에서 운영
• 브랜치 전략 : 개발 / 스테이징 / 운영 서버 구축

도구 선정의 기준은 GitHub 통합성, 속도, 비용, 보안 모델

CI/CD 도구 점유율 [Jetbrain 참고 링크] GitLab/Azure 환경을 사용하지않기에 제외하였습니다.

⇒ GitHub Actions는 GitHub 기반 워크플로우이기에 머지 규칙, 권한/시크릿 관리와 같은 통합성이 제일 좋습니다. 또한, 버저닝 관리없이 쉽게 자동화할 수 있으며, 비용 부담 없이 빠르게 구축 가능하기에 선정하게 되었습니다.

브랜치 흐름도 요약

(feat/*) → develop → release → main
			                    ↑
		                     hotfix/*

운영 시 유의사항

별도의 상시 Release 서버를 운영하는 것이 아니라 선택적으로 Release 환경을 구성하는 전략을 채택하였습니다.

1. 배포 안정성 확보

• Release 환경을 필요 시에만 구성하면,
  • 운영 트래픽과 분리된 공간에서 배포 전 검증(QA/부하)을 수행할 수 있고
  • 문제 발생 시에도 Dev/Main에 미치는 영향을 최소화할 수 있습니다.
• 또한 릴리즈 직전 운영과 동일한 조건에서 검증 후 배포함으로써, 배포 안정성을 높일수 있습니다.

2. 리소스 및 비용

• 부하테스트 및 QA를 진행하기 위해서 운영 서버와 동일하게 진행해야하기에, 동일한 스펙(High-spec)의 환경이 필수입니다.
• Release 환경 없이 Dev 서버로만 가동할 경우, 실제 트래픽 사용률이 낮음에도 불구하고 테스트를 위해 높은 비용을 유지해야 합니다.
  • 운영과 동일한 $75.92 의 비용이 예상되며, 운영/개발에 약$152 달러 청구 예상
• 선택적으로 Release 환경을 구성하게 된다면, 개발 환경에서는 낮은 스펙으로 진행해도 된다고 판단했습니다.
  • Idle한 상태에서 기본 설치 시, 필요한 메모리 1.2GB
  • 개발 환경에서는 지연 시간이 허용된다고 판단하여, 스왑 메모리 통한 추가 메모리 확보
    • 프로세스가 많은 단일 인스턴스 특성 상, Context Switching 이 적도록 CPU가 많은 인스턴스가 필요하다고 판단
    • t2에 비해서 CPU가 1코어 더 많고 저렴한 t3를 선정
  • 개발환경에서는 t3.small 1대 설정하여, 한 달(744시간)에 약$22 청구 예상

⇒ 35.5% 더 저렴하게 운영가능

3. 운영의 복잡성 가능성 존재

• 클라우드 환경을 최대 3개까지 구축해야된다는 단점이 존재합니다.
• 하지만, Artifact의 유지 및 CD으로의 확장성을 고려한다면 수동 배포의 환경보다는 운영의 난이도가 낮아진다고 판단했고, 비용적 측면과 안정성이 늘어난다는 장점을 택하기로 판단했습니다.

• 각 단계를 실행할 때, 하나의 파이프라인이라도 실패 시, merge 불가능

3-4-1. Lint

소스 코드의 스타일 불일치, 구문 오류 및 코딩 규칙 준수 여부를 분석

• 목적: 코드 스타일/포맷/기초 규칙을 빠르게 통과시키고 PR 품질을 균일화
• 대상: 공통
• 사용 도구
  • Front: eslint, prettier
  • Python: ruff, eslint, prettier
  • Java: eslint, prettier
• Lint 실패 시, PR 머지 실패

3-4-2. 정적 분석

소스 코드를 실행하지 않고 취약점 식별, 버그, 성능 문제, 코딩 표준 미준수 등에 대한 잠재적인 문제에 대해 분석

• 우리 서비스, 정적 분석 도구의 선택 기준은 비용과 취약점 식별 과 버그 식별이다.정적 분석 이전에 Lint의 작업이 있기에 코딩 표준 미준수는 가중치를 낮게 두고 진행함

⇒ CodeQL은 GitHub 저장소/PR 흐름에 “내장형”으로 붙고, 취약점 및 오류(버그성) 탐지가 공식적으로 목적에 포함 되어 있어, 초기 운영 비용과 도입/운영 오버헤드를 최소화하면서 필요한 수준의 보안·버그 탐지를 확보할 수 있기에 선정하였습니다.

3-4-3. 테스트

• 목적: “코드가 의도대로 동작하는지”를 실행으로 검증
• 범위
  • 단위 테스트(Unit Test): 함수/모듈 레벨 로직 검증 (가장 빠르고 많이)
  • 통합 테스트(Integration Test): DB/외부 API 연동에서 테스트 검증
    • 우리서비스는 외부 API가 3개로 많기에, 실제 호출 대신 Mock/Stubbing으로 항상 같은 응답을 받게 만들어서 테스트 신뢰도 높이고자 합니다.
• 산출물
  • 테스트 리포트 업로드
  • 커버리지 리포트 : “유지보수 가능한 수준의 최소 기준”만 설정

3-4-4. 빌드

• 목적: 배포 가능한 산출물 (실행파일/정적파일/패키지) 을 생성

• 수행 작업

  • 종속성 설치 및 빌드
    • Front: npm run build (정적 산출물 생성)
    • Backend(Java): gradle build (jar 생성)
    • Backend(Python): 패키징/의존성 고정 후 실행 단위 구성
  • 빌드 캐시 활용 : 의존성 캐시로 CI 속도 안정화

• 품질 기준

  • 불필요한 빌드 낭비 방지위해서, 빌드는 “테스트 통과 후” 에만 수행
  • 빌드 결과물에 버전 식별자(commit hash / tag / build number)를 반드시 포함

3-4-5. Artifact 업로드를 해야하는 이유

• artifact는 빌드된 실행 파일 또는 정적 파일을 의미하며, 커밋 해시를 기준으로 저장되어 롤백 시 정확한 시점 복원이 가능합니다.
• 다중 인스턴스의 확장성을 고려해서 산출물을 공통의 저장소에 저장하는 과정이 필요하다.

4-1-1. 속도를 빠르게 만들기 위한 캐싱

실제 이미지 확인

• 매번 빌드를 진행할때마다 속도가 매우 느리기에 어떤 것이 문제인가 확인을 해보았더니, Gradle과 같은 의존성 설치에서 4분 40초가 걸리는 모습을 확인할 수 있음
• Gradle 캐싱으로 98.9% 감소

4-1-2. 통합 테스트를 위한 환경 설정 구성

통합 테스트를 위한 환경 설정 기준 멱등성, 격리성, 유지보수 으로 잡았습니다.

⇒ GitHub Service Containers 방식을 채택하였습니다.

1. 멱등성

• Self-hosted Runner는 이전 테스트가 남긴 데이터나 프로세스가 다음 테스트에 영향을 주는 '환경 오염' 문제 가능성이 존재합니다.
• Service Containers는 Job 시작 시 컨테이너를 생성하고 종료 시 즉시 파기합니다. 어떤 시점에 실행하더라도 항상 완벽하게 깨끗한 상태(Fresh State)에서 테스트가 시작되므로, 코드 변경 외의 외부 요인으로 테스트 결과가 달라지지 않는 멱등성을 보장합니다.

2. 격리성 : 충돌 없는 병렬 테스트

• Self-hosted Runner는 여러 빌드가 동시에 돌아갈 경우 포트 충돌이나 리소스 간섭이 발생할 수 있습니다.
• 각 테스트는 독립된 Docker 컨테이너 네트워크 내에서 실행됩니다. 동일한 포트(예: MySQL 3306)를 사용하더라도 컨테이너 단위로 완벽히 격리되어 있어, 병렬 빌드 시에도 안정적인 테스트가 가능합니다.

3. 유지보수성 : 테스트 환경의 관리

• 직접 설치는 OS 업데이트에 따른 스크립트 수정이 필요하고, Self-hosted Runner는 EC2의 보안 패치, 디스크 용량, 라이브러리 관리를 개발자가 직접 수행해야 합니다.
• 서비스 컨테이너는 YAML 파일 내에 사용할 이미지와 버전만 명시하면 됩니다. GitHub가 관리하는 관리형 서비스를 활용함으로써 인프라 운영 부담을 최소화하고 비즈니스 로직 검증에 집중할 수 있습니다.

4-1-3. GitHub Secrets 환경 설정 구성

공통
- `DISCORD_WEBHOOK_URL` : 전달할 전체 디스코드 채팅방
- `AWS_REGION` : 지역
- `AWS_ACCESS_KEY` : AWS AccessKey
- `AWS_SECRET_KEY`  : AWS SecretKey
- `BUCKET_NAME` : S3버킷 이름

BE

- `DISCORD_WEBHOOK_URL_BE` : 전달할 직군 디스코드 채팅방
- `application-test.yml` : 테스트용 YAML

FE

- `DISCORD_WEBHOOK_URL_FE` : 전달할 직군 디스코드 채팅방
- `env` : ENV

AI

- `DISCORD_WEBHOOK_URL_AI` : 전달할 직군 디스코드 채팅방
- `env` : ENV

4-1-4. 브랜치 보호

• develop, release, main 에서 “Require status checks to pass” 활성화

4-2-1. BE 관련 파이프라인 설계

• BE 파이프라인 PR 설계 (펼치기)

  name: Devths-BE PR 파이프라인
  
  on:
    pull_request:
      branches:
        - develop
        - release
        - main
  
  env:
    JAVA_VERSION: "21"
   
  jobs:
    lint:
      name: lint
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  			
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  
  			- name: Gradle 캐싱
          uses: actions/cache@v3
          with:
            path: |
              ~/.gradle/caches
              ~/.gradle/wrapper
            key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
            restore-keys: |
              gradle-${{ runner.os }}
  
        - name: Lint 수행
          run: 린트 수행
  
    static_analysis:
      name: static-analysis
      runs-on: ubuntu-22.04
      needs: [lint]
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  
        - name: 정적 분석 진행
          run : 정적 분석 도구 선정 후 진행
  
    test:
      name: test
      runs-on: ubuntu-22.04
      needs: [static_analysis]
  
      services:
        mysql:
          image: mysql:8.0
          env:
          # 테스트용 서비스이기에 노출되어도 문제 없음
            MYSQL_ROOT_PASSWORD: root
            MYSQL_DATABASE: app
            MYSQL_USER: app
            MYSQL_PASSWORD: app
          ports:
            - 3306:3306
          options: >-
            --health-cmd="mysqladmin ping -h 127.0.0.1 -u root -proot"
            --health-interval=10s
            --health-timeout=5s
            --health-retries=10
  
      steps:
        - name: 레포지토리 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설정
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  			
  			- name: Application-test 주입
  				run: |
            mkdir -p src/test/resources
            echo "${{secrets.APPLICATION_TEST_YML}}" > ./src/test/resources/application-test.yml
  						
        - name: 테스트 실행
          run: ./gradlew test
  
        - name: 테스트 결과 확인
          if: always()
          uses: actions/upload-artifact@v4
          with:
            name: be-test-reports-${{ github.sha }}
            path: |
              build/reports/tests
              build/test-results
            if-no-files-found: ignore
  
        - name: Jacoco 커버리지 확인하기
          if: always()
          uses: actions/upload-artifact@v4
          with:
            name: be-coverage-${{ github.sha }}
            path: |
              build/reports/jacoco
            if-no-files-found: ignore
  
    build:
      name: build
      runs-on: ubuntu-22.04
      needs: [test] # 테스트 통과 후 빌드
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
        			
        - name: Bootjar 기반 빌드(테스트 통과)
          run: ./gradlew bootJar -x test --no-daemon
  
    notify-discord:
  	  name: notify
      runs-on: ubuntu-22.04
      needs: build
      if: always()
      steps:
        - name: Discord 빌드 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ github.event.pull_request.base.ref == 'develop' && secrets.DISCORD_WEBHOOK_URL_BE || secrets.DISCORD_WEBHOOK_URL }}
            title: "${{ needs.build.result == 'success' && '✅' || '❌' }} 새로운 PR이 올라왔습니다!"
            description: |
              **제목**: ${{ github.event.pull_request.title }}
              **작성자**: ${{ github.event.pull_request.user.login }}
              **브랜치**: `${{ github.event.pull_request.base.ref }}`←`${{ github.event.pull_request.head.ref }}`
  
              **📊 빌드 결과**:
              - 상태: ${{ needs.build.result == 'success' && '성공' || '실패' }}
  
              **🔗 링크**:
              - [PR 확인하기](${{ github.event.pull_request.html_url }})
  
            color: "${{ needs.build.result == 'success' && 65280 || 16711680 }}"
            username: GitHub PR Bot
            avatar_url: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png

• BE 파이프라인 Merge 설계 (펼치기)

  name: Devths-BE
  
  on:
  
    push:
      branches:
        - develop
        - release
        - main
  
  env:
    JAVA_VERSION: "21"
    AWS_REGION: ${{ secrets.AWS_REGION }}
    S3_BUCKET: ${{ secrets.S3_BUCKET }}
    S3_PREFIX: ci/${{ github.repository }}/${{ github.ref_name }}/${{ timestamp }}_${{ github.sha }} #커밋 및 시간 기준 해시
  
  jobs:
    lint:
      name: lint
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  			
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  
  			- name: Gradle 캐싱
          uses: actions/cache@v3
          with:
            path: |
              ~/.gradle/caches
              ~/.gradle/wrapper
            key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
            restore-keys: |
              gradle-${{ runner.os }}
  
        - name: Lint 수행
          run: 린트 수행
  
    static_analysis:
      name: static-analysis
      runs-on: ubuntu-22.04
      needs: [lint]
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  
        - name: 정적 분석 진행
          run : 정적 분석 도구 선정 후 진행
  
    test:
      name: test
      runs-on: ubuntu-22.04
      needs: [static_analysis]
  
      # 통합테스트용 서비스 컨테이너 설정
      services:
        mysql:
          image: mysql:8.0
          env:
          # 테스트용 서비스이기에 노출되어도 문제 없음
            MYSQL_ROOT_PASSWORD: root
            MYSQL_DATABASE: app
            MYSQL_USER: app
            MYSQL_PASSWORD: app
          ports:
            - 3306:3306
          options: >-
            --health-cmd="mysqladmin ping -h 127.0.0.1 -u root -proot"
            --health-interval=10s
            --health-timeout=5s
            --health-retries=10
  
      steps:
        - name: 레포지토리 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설정
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
  			
  			- name: Application-test 주입
  				run: |
            mkdir -p src/test/resources
            echo "${{secrets.APPLICATION_TEST_YML}}" > ./src/test/resources/application-test.yml
  						
        - name: 테스트 실행
          run: ./gradlew test
  
        - name: 테스트 결과 확인
          if: always()
          uses: actions/upload-artifact@v4
          with:
            name: be-test-reports-${{ github.sha }}
            path: |
              build/reports/tests
              build/test-results
            if-no-files-found: ignore
  
        - name: Jacoco 커버리지 확인하기
          if: always()
          uses: actions/upload-artifact@v4
          with:
            name: be-coverage-${{ github.sha }}
            path: |
              build/reports/jacoco
            if-no-files-found: ignore
  
    build:
      name: build
      runs-on: ubuntu-22.04
      needs: [test] # 테스트 통과 후 빌드
      steps:
        - name: 체크아웃
        - uses: actions/checkout@v4
  
        - name: 자바 설치
          uses: actions/setup-java@v4
          with:
            distribution: temurin
            java-version: ${{ env.JAVA_VERSION }}
        			
        - name: Bootjar 기반 빌드(테스트 통과)
          run: ./gradlew bootJar -x test --no-daemon
   
        - name: AWS 자격 증명 설정
          uses: aws-actions/configure-aws-credentials@v4
          with:
            aws-access-key-id: ${{secrets.AWS_ACCESS_KEY}}
            aws-secret-access-key: ${{secrets.AWS_SECRET_KEY}}
            aws-region: ${{secrets.AWS_REGION}}
  
        - name: JAR을 S3 업로드
          run: |
            set -euo pipefail
            DEST="s3://${S3_BUCKET}/${S3_PREFIX}/artifacts/jar"
            mkdir -p /tmp/jars
  
            # build/libs/*.jar 업로드 (여러 개일 수 있어 for 처리)
            shopt -s nullglob
            files=(build/libs/*.jar)
            if [ ${#files[@]} -eq 0 ]; then
              echo "No jar found in build/libs"
              exit 1
            fi
  
            for f in "${files[@]}"; do
              aws s3 cp "$f" "${DEST}/$(basename "$f")" --only-show-errors
            done
  
    notify-discord:
      name: notify
      runs-on: ubuntu-22.04
      needs: build
      if: always()
      steps:
        - name: Discord 빌드 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ secrets.DISCORD_WEBHOOK_BACK_URL }}
            title: "${{ needs.build.result == 'success' && '✅' || '❌' }} 새로운 PR이 올라왔습니다!"
            description: |
              **제목**: ${{ github.event.pull_request.title }}
              **작성자**: ${{ github.event.pull_request.user.login }}
              **브랜치**: `${{ github.event.pull_request.base.ref }}`←`${{ github.event.pull_request.head.ref }}`
  
              **📊 빌드 결과**:
              - 상태: ${{ needs.build.result == 'success' && '성공' || '실패' }}
  
              **🔗 링크**:
              - [PR 확인하기](${{ github.event.pull_request.html_url }})
  
            color: "${{ needs.build.result == 'success' && 65280 || 16711680 }}"
            username: GitHub PR Bot
            avatar_url: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png

4-2-2. FE 관련 파이프라인 설계

• FE 파이프라인 PR 설계 (펼치기)

  name: Devths-FE PR 파이프라인
  
  on:
    pull_request:
      branches:
        - develop
        - release
        - main
  
  env:
    NODE_VERSION: "20.x"
  
  jobs:
    # 1. Lint 단계
    lint:
      name: lint
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
        
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
          
        - name: Lint 분석
          run: npm run lint
  
    # 2. 정적 분석 단계 (Lint 성공 시 실행)
    static-analysis:
      name: static-analysis (CodeQL)
      needs: [lint]
      runs-on: ubuntu-22.04
      permissions:
        actions: read
        contents: read
        security-events: write # 결과를 Security 탭에 기록하기 위해 필요
  
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
  
        - name: CodeQL 초기화
          uses: github/codeql-action/init@v2
          with:
            languages: javascript # TS를 포함한 JS 환경 분석
  
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
  
        - name: CodeQL 분석 수행
          uses: github/codeql-action/analyze@v2
  
    # 3. 테스트 단계 (정적 분석 성공 시 실행)
    test:
      name: test
      needs: [static-analysis]
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
  
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
  			
        - name: 의존성 설치
          run: npm ci
  				
        - name: 테스트 실행 (JUnit 리포트 생성)
          run: npm test -- --reporters=default --reporters=jest-junit
          env:
            JEST_JUNIT_OUTPUT_DIR: "./test-results"
            JEST_JUNIT_OUTPUT_NAME: "test-results.xml"
  
  			- name: Test 결과 업로드
          uses: EnricoMi/publish-unit-test-result-action@v2
          if: always()
          with:
            files: 'test-results/test-results.xml'
  							  
    # 4. 빌드 단계 (테스트 성공 시 실행)
    build:
      name: build
      needs: [test]
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
        
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
        
        - name: 프로젝트 빌드
          run: npm run build
  		
    # 5. 디스코드 알림 단계 (항상 실행되지만 빌드 결과를 리포트함)
    notify-discord:
      name: notify
      runs-on: ubuntu-22.04
      needs: [build] # 빌드 단계의 결과를 기다림
      if: always()
      steps:
        - name: Discord 빌드 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ github.event.pull_request.base.ref == 'develop' && secrets.DISCORD_WEBHOOK_URL_FE || secrets.DISCORD_WEBHOOK_URL }}
            title: "${{ needs.build.result == 'success' && '✅' || '❌' }} 프런트 새로운 PR이 올라왔습니다!"
            description: |
              **제목**: ${{ github.event.pull_request.title }}
              **작성자**: ${{ github.event.pull_request.user.login }}
              **브랜치**: `${{ github.event.pull_request.base.ref }}` ← `${{ github.event.pull_request.head.ref }}`
              
              **📊 최종 빌드 결과**:
              - 상태: ${{ needs.build.result == 'success' && '성공' || '실패' }}
              
              **🔗 링크**:
              - [PR 확인하기](${{ github.event.pull_request.html_url }})
  
            color: "${{ needs.build.result == 'success' && 65280 || 16711680 }}"
            username: GitHub PR Bot
            avatar_url: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png

• FE 파이프라인 Merge 설계 (펼치기)

  name: DevthsFE 파이프라인
  
  on:
    push:
      branches:
        - develop
        - release
        - main
  env:
    NODE_VERSION: "20.x"
    AWS_REGION: ${{ secrets.AWS_REGION }}
    S3_BUCKET: ${{ secrets.S3_BUCKET }}
    S3_PREFIX: ci/${{ github.repository }}/${{ github.ref_name }}/${{ timestamp }}_${{ github.sha }} #커밋 및 시간 기준 해시
  
  jobs:
    # 1. Lint 단계
    lint:
      name: lint
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
        
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
          
        - name: Lint 분석
          run: npm run lint
  
    # 2. 정적 분석 단계 (Lint 성공 시 실행)
    static-analysis:
      name: static-analysis (CodeQL)
      needs: [lint]
      runs-on: ubuntu-22.04
      permissions:
        actions: read
        contents: read
        security-events: write # 결과를 Security 탭에 기록하기 위해 필요
  
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
  
        - name: CodeQL 초기화
          uses: github/codeql-action/init@v2
          with:
            languages: javascript # TS를 포함한 JS 환경 분석
  
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
  
        - name: CodeQL 분석 수행
          uses: github/codeql-action/analyze@v2
  
    # 3. 테스트 단계 (정적 분석 성공 시 실행)
    test:
      name: test
      needs: [static-analysis]
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
  
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
  			
        - name: 의존성 설치
          run: npm ci
  				
        - name: 테스트 실행 (JUnit 리포트 생성)
          run: npm test -- --reporters=default --reporters=jest-junit
          env:
            JEST_JUNIT_OUTPUT_DIR: "./test-results"
            JEST_JUNIT_OUTPUT_NAME: "test-results.xml"
  
  			- name: Test 결과 업로드
          uses: EnricoMi/publish-unit-test-result-action@v2
          if: always()
          with:
            files: 'test-results/test-results.xml'
  							  
    # 4. 빌드 단계 (테스트 성공 시 실행)
    build:
      name: build
      needs: [test]
      runs-on: ubuntu-22.04
      steps:
        - name: 체크아웃
          uses: actions/checkout@v3
        
        - name: 노드 JS 설치
          uses: actions/setup-node@v3
          with:
            node-version: ${{ env.NODE_VERSION }}
            cache: 'npm'
        
        - name: 의존성 설치
          run: npm ci
        
        - name: 프로젝트 빌드
          run: npm run build
  			
  			- name: AWS 자격 증명 설정
          uses: aws-actions/configure-aws-credentials@v4
          with:
            aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
            aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
            aws-region: ${{ env.AWS_REGION }}
  
        - name: S3 고유 경로로 업로드
          run: |
            # 사용자가 정의한 prefix 규칙 적용
            S3_PATH="s3://${{ env.S3_BUCKET }}/ci/${{ github.repository }}/${{ github.ref_name }}/${{ env.TIMESTAMP }}_${{ github.sha }}"
            aws s3 sync ./dist $S3_PATH
            echo "DEPLOY_URL=$S3_PATH" >> $GITHUB_ENV
  			
    # 5. 디스코드 알림 단계 (항상 실행되지만 빌드 결과를 리포트함)
    notify-discord:
      name: notify
      runs-on: ubuntu-22.04
      needs: [build] # 빌드 단계의 결과를 기다림
      if: always()
      steps:
        - name: Discord 빌드 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ github.event.pull_request.base.ref == 'develop' && secrets.DISCORD_WEBHOOK_URL_FE || secrets.DISCORD_WEBHOOK_URL }}
            title: "${{ needs.build.result == 'success' && '✅' || '❌' }} 프런트 새로운 PR이 올라왔습니다!"
            description: |
              **제목**: ${{ github.event.pull_request.title }}
              **작성자**: ${{ github.event.pull_request.user.login }}
              **브랜치**: `${{ github.event.pull_request.base.ref }}` ← `${{ github.event.pull_request.head.ref }}`
              
              **📊 최종 빌드 결과**:
              - 상태: ${{ needs.build.result == 'success' && '성공' || '실패' }}
              
              **🔗 링크**:
              - [PR 확인하기](${{ github.event.pull_request.html_url }})
  
            color: "${{ needs.build.result == 'success' && 65280 || 16711680 }}"
            username: GitHub PR Bot
            avatar_url: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png

4-2-3. AI 관련 파이프라인 설계

• AI 파이프라인 PR 설계 (펼치기)

  name: Devths-AI PR CI 파이프라인
  
  on:
    pull_request:
      branches: 
      - develop
      - release
      - main
  
  env:
    PYTHON_VERSION: "3.10.19"
  
  jobs:
    # 1. Lint 단계 (Ruff)
    lint:
      name: lint (Ruff)
      runs-on: ubuntu-22.04
      steps:
        - name : 체크아웃
          uses: actions/checkout@v4
        
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        
        - name: Ruff 설치 및 실행
          run: |
            pip install ruff
            ruff check .
  
    # 2. 정적 분석 단계 (CodeQL)
    static-analysis:
      name: static-analysis (CodeQL)
      needs: [lint]
      runs-on: ubuntu-22.04
      permissions:
        security-events: write
      steps:
        - name : 체크아웃
          uses: actions/checkout@v4
    
        - name: CodeQL 초기화
          uses: github/codeql-action/init@v2
          with:
            languages: python
    
        - name: CodeQL 분석 수행
          uses: github/codeql-action/analyze@v2
  
    # 3. 테스트 단계 (Pytest)
    test:
      name: test (Pytest)
      needs: [static-analysis]
      runs-on: ubuntu-22.04
      permissions:
        checks: write
        pull-requests: write
      steps:
        - name : 체크아웃
          uses: actions/checkout@v4
        
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        
        - name: 의존성 설치
          run: |
            python -m pip install --upgrade pip
            pip install -r requirements.txt
            pip install pytest pytest-xml-report
        
        - name: 테스트 실행
          run: pytest --junitxml=test-results.xml
        
        - name: Test 결과 업로드
          uses: EnricoMi/publish-unit-test-result-action@v2
          if: always()
          with:
            files: 'test-results.xml'
  
    # 4. 빌드 단계
    build:
      name: build
      needs: [test]
      runs-on: ubuntu-22.04
      steps:
        - name : 체크아웃
          uses: actions/checkout@v4
          
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        
        - name: 의존성 설치 및 빌드 검증
          run: |
            python -m pip install --upgrade pip
            pip install -r requirements.txt
  
    # 5. 디스코드 알림
    notify-discord:
      name: notify
      runs-on: ubuntu-22.04
      needs: [build]
      if: always()
      steps:
        - name: Discord 빌드 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ github.event.pull_request.base.ref == 'develop' && secrets.DISCORD_WEBHOOK_URL_AI || secrets.DISCORD_WEBHOOK_URL }}
            title: "${{ needs.build.result == 'success' && '✅' || '❌' }} AI PR 파이프라인 결과"
            description: |
              **제목**: ${{ github.event.pull_request.title }}
              **작성자**: ${{ github.event.pull_request.user.login }}
              **상태**: ${{ needs.build.result == 'success' && '성공' || '실패' }}
  
              **📊 분석 요약**:
              - Lint: Ruff 검사 완료
              - Security: CodeQL 정적 분석 완료
              - Test: Pytest 단위 테스트 완료
              - Build: Pip 의존성 검증 완료
              
              **🔗 링크**:
              - [PR 확인하기](${{ github.event.pull_request.html_url }})
  
            color: "${{ needs.build.result == 'success' && 65280 || 16711680 }}"
            username: GitHub AI Bot
            avatar_url: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png

• AI 파이프라인 Merge 설계 (펼치기)

  name: Devths-AI 배포 파이프라인
  
  on:
    push:
      branches:
        - develop
        - release
        - main
  
  env:
    PYTHON_VERSION: "3.10.19"
    AWS_REGION: ${{ secrets.AWS_REGION }}
    S3_BUCKET: ${{ secrets.S3_BUCKET_AI }}
  
  jobs:
    # 1. Lint 단계
    lint:
      name: lint (Ruff)
      runs-on: ubuntu-22.04
      steps:
        - uses: actions/checkout@v4
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        - run: pip install ruff
        - run: ruff check .
  
    # 2. 정적 분석 (CodeQL)
    static-analysis:
      name: static-analysis (CodeQL)
      needs: [lint]
      runs-on: ubuntu-22.04
      permissions:
        security-events: write
      steps:
        - uses: actions/checkout@v4
        - name: CodeQL 초기화
          uses: github/codeql-action/init@v2
          with:
            languages: python
        - name: CodeQL 분석 수행
          uses: github/codeql-action/analyze@v2
  
    # 3. 테스트 단계
    test:
      name: test (Pytest)
      needs: [static-analysis]
      runs-on: ubuntu-22.04
      permissions:
        checks: write
        pull-requests: write
      steps:
        - uses: actions/checkout@v4
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        - run: |
            pip install -r requirements.txt
            pip install pytest pytest-xml-report
        - name: 테스트 실행
          run: pytest --junitxml=test-results.xml
        - name: Test 결과 업로드
          uses: EnricoMi/publish-unit-test-result-action@v2
          if: always()
          with:
            files: 'test-results.xml'
  
    # 4. 빌드 및 S3 업로드
    build_and_deploy:
      name: build and S3 upload
      needs: [test]
      runs-on: ubuntu-22.04
      steps:
        - uses: actions/checkout@v4
        - name: 파이썬 설정
          uses: actions/setup-python@v4
          with:
            python-version: ${{ env.PYTHON_VERSION }}
            cache: 'pip'
        
        # 타임스탬프 생성
        - name: 타임스탬프 생성
          run: echo "TIMESTAMP=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV
  
        - name: AWS 자격 증명 설정
          uses: aws-actions/configure-aws-credentials@v4
          with:
            aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
            aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
            aws-region: ${{ env.AWS_REGION }}
  
        - name: S3로 소스 패키지 업로드
          run: |
            # 1. 업로드할 경로 설정 (prefix)
            S3_PATH="s3://${{ env.S3_BUCKET }}/ci/${{ github.repository }}/${{ github.ref_name }}/${{ env.TIMESTAMP }}_${{ github.sha }}"
            
            # 2. 불필요한 파일(.git, __pycache__ 등) 제외하고 동기화
            aws s3 sync . $S3_PATH \
              --exclude ".git/*" \
              --exclude ".github/*" \
              --exclude "__pycache__/*" \
              --exclude "*.pyc" \
              --exclude ".pytest_cache/*"
              
            echo "DEPLOY_PATH=$S3_PATH" >> $GITHUB_ENV
  
    # 5. 디스코드 알림
    notify-discord:
      name: notify
      runs-on: ubuntu-22.04
      needs: [build_and_deploy]
      if: always()
      steps:
        - name: Discord 배포 알림
          uses: sarisia/actions-status-discord@v1
          with:
            webhook: ${{ github.ref_name == 'develop' && secrets.DISCORD_WEBHOOK_URL_AI || secrets.DISCORD_WEBHOOK_URL }}
            title: "${{ needs.build_and_deploy.result == 'success' && '✅' || '❌' }} AI 배포 파이프라인 결과"
            description: |
              **이벤트**: PUSH (`${{ github.ref_name }}`)
              **작성자**: ${{ github.actor }}
              **상태**: ${{ needs.build_and_deploy.result == 'success' && '성공' || '실패' }}
              
              **📊 배포 정보**:
              - S3 저장 경로: `ci/${{ github.repository }}/${{ github.ref_name }}/...`
              
              **🔗 링크**:
              - [GitHub Actions 실행 확인](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
            color: "${{ needs.build_and_deploy.result == 'success' && 65280 || 16711680 }}"
            username: GitHub AI Bot

• 우리 서비스의 알림 시스템 선택 기준은 접근성, 확장성, 비용입니다.
• 알림 자체가 개발자들에게 명확하고 쉽게 전달될 수 있어야합니다.
• CI의 알림 뿐 아니라, 모니터링에서까지 알림이 사용되어야 하기에 확장성이 좋은 것을 선택하기로 판단했습니다.

알림 서비스 비교

요즘IT(월간 PV 100만, MAU 46만, 뉴스레터 8만5천.) 매거진 내 발췌 (2025.09.18 기준) 예외적으로 현재 사용중인 디스코드를 추가하여, 협업용 메신저툴 비교

⇒ Slack은 자체 API가 존재하여 알림 연동이 더 쉽다는 장점이 존재하지만, 다른 서비스 또한 webhook을 통해서 알림 전달이 가능합니다. 그렇기에, 우리 서비스에서는 적응성/비용에 더 가산점을 두어서, 기존에 쓰는 Discord를 알림 메신저로 선정 하였습니다.

5-2-1. 알림 메시지 포맷 및 예시

Success: ✅ [브랜치명] 브랜치 배포 결과
커밋 메시지: [커밋 제목]
작성자: [작성자]
브랜치: [브랜치명]

📊 빌드/배포 결과:
상태: [성공/실패]

Event - [push/pr]

Triggered by [개발자명]

2025. 12. 18. 오후 7:47

5-2-2. CI 파이프라인 알림 구성

• 빌드/테스트 결과에 따라 Discord 알림을 자동 생성
• 개발자가 테스트가 실패했는지와 관련 커밋으로 바로 이동하여 확인할 수 있도록 구성
• 너무 많은 알람이 존재한다면, 알람 전달에 대한 방해

  • 브랜치 및 상황에 따라서 전달되는 채팅방 지정

    케이스	소스 브랜치	타깃 브랜치	상황	알림 채팅방
    1	Feat/*	Dev	PR 결과	해당 직군 채팅방(FE/BE/AI)
    2	Feat/*	Dev	Merge 결과	전체 채팅방
    3	Dev	Release	PR/Merge	전체 채팅방
    4	Release	Main	PR/Merge 결과	전체 채팅방
    5	Hotfix	Main	PR/Merge 결과	전체 채팅방

# 빌드/테스트 수행
result = runBuildPipeline()  # lint → test → build

# 결과에 따라 메시지 구성
if result == SUCCESS:
    status = "✅ 성공"
    color = GREEN
else:
    status = "❌ 실패"
    color = RED

# Discord 알림 전송
sendDiscordWebhook(
    title = f"{status} - 브랜치 배포 결과",
    description = f"커밋: <커밋 메시지>\n작성자: <작성자>\n브랜치: <브랜치 이름>\n상태: {status}",
    color = color
)