DevOps & 클라우드

GitHub Actions는 CI/CD 파이프라인을 구축하는 데 매우 유용한 도구입니다. 이를 통해 자동화된 빌드, 테스트 및 배포 프로세스를 설정할 수 있습니다. 하지만 최적화하지 않으면 불필요한 시간과 자원을 소모하게 될 수 있습니다. 이번 포스트에서는 CI/CD에서 GitHub Actions를 최적화하는 7가지 팁을 소개합니다.

1. 불필요한 워크플로우 실행 방지하기

GitHub Actions는 특정 이벤트에 따라 워크플로우를 실행합니다. 하지만 모든 커밋이나 푸시에서 워크플로우가 실행될 필요는 없습니다. 예를 들어, 문서 변경이나 README 파일 수정 시에는 CI/CD가 필요하지 않을 수 있습니다. 이를 방지하기 위해 워크플로우 트리거를 조정해보세요.

on:
  push:
    paths-ignore:
      - 'README.md'
      - 'docs/**'

위의 설정은 README.md 파일이나 docs 폴더 내의 변화가 있을 때는 워크플로우가 실행되지 않도록 합니다.

2. 캐시 활용하기

의존성 설치 시 시간을 절약할 수 있는 가장 좋은 방법 중 하나는 캐시를 사용하는 것입니다. GitHub Actions에서는 actions/cache를 사용하여 빌드와 테스트에서 패키지 의존성을 캐시할 수 있습니다.

steps:
  - name: Cache Node modules
    uses: actions/cache@v2
    with:
      path: ~/.npm
      key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
      restore-keys: |
        ${{ runner.os }}-node-

이렇게 하면 의존성이 변경되지 않는 한, 매번 의존성을 다시 다운로드할 필요가 없어집니다.

3. 병렬 실행 활용하기

여러 개의 테스트가 있을 때, 모든 테스트를 순차적으로 실행하는 것보다 병렬로 실행하면 시간 단축이 가능합니다. GitHub Actions에서는 jobs를 사용하여 병렬 실행을 지원합니다.

jobs:
  test-node:
    runs-on: ubuntu-latest
    steps:
      - run: npm test

  test-python:
    runs-on: ubuntu-latest
    steps:
      - run: python -m unittest discover

위와 같이 각 언어별로 테스트를 병렬로 실행할 수 있습니다.

4. 컨테이너 이미지 사용하기

애플리케이션을 컨테이너화하면 DevOps 프로세스를 더 효율적으로 만들 수 있습니다. GitHub Actions에서는 Docker 컨테이너를 직접 사용할 수 있으며, 이를 통해 개발 환경을 통일하고 의존성 문제를 줄일 수 있습니다.

jobs:
  build:
    runs-on: ubuntu-latest
    container:
      image: node:14
    steps:
      - run: npm install

이렇게 함으로써 특정 버전의 노드 환경에서 일관된 빌드를 유지할 수 있습니다.

5. 환경 변수 및 비밀 관리하기

GitHub Secrets를 활용하여 민감한 정보를 안전하게 관리할 수 있습니다. API 키나 데이터베이스 비밀번호 같은 정보는 .env 파일에 직접 작성하는 것보다 비밀 관리 기능을 사용하는 것이 좋습니다.

steps:
  - name: Deploy
    run: |
      echo "DATABASE_URL=${{ secrets.DATABASE_URL }}" > .env

이렇게 하면 비밀 정보가 노출되는 위험을 줄일 수 있습니다.

6. YAML 파일 정리하기

복잡한 워크플로우 파일은 유지보수가 어려워질 수 있습니다. 중복된 코드를 줄이고, 공통적인 스크립트는 별도의 YAML 파일이나 액션으로 모듈화하여 관리하세요.

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - run: ./scripts/test.sh

별도의 스크립트 파일을 만들어 관리하면, 프로세스를 더 쉽게 이해하고 수정할 수 있습니다.

7. 알림 및 피드백 설정하기

CI/CD 파이프라인의 상태를 팀원과 공유하는 것은 매우 중요합니다. 이를 위해 Slack이나 이메일과 같은 서비스를 통해 알림을 설정할 수 있습니다.

steps:
  - name: Notify Slack
    uses: 8398a7/action-slack@v3
    env:
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
      SLACK_MESSAGE: 'CI/CD job completed successfully!'

이렇게 하면, 작업이 완료되었을 때 자동으로 팀에게 알림을 보낼 수 있습니다.

마무리

GitHub Actions는 CI/CD 파이프라인을 간소화하고 효율성을 높이는 강력한 도구입니다. 최적화를 통해 시간과 리소스를 절약하고, 개발 프로세스를 더욱 원활하게 만들 수 있습니다. 위에서 소개한 7가지 팁을 활용하여 여러분의 GitHub Actions 워크플로우를 최적화해보세요. 더 나아가 지속적으로 개선하고 조정하는 것이 중요합니다. Happy Coding!

.github/workflows/test.yml