GitHub Action

GitHub Action은 GitHub에서 제공하는 CI/CD 도구입니다. GitHub Action을 사용하면 코드를 변경할 때마다 자동으로 빌드, 테스트 및 배포를 수행할 수 있습니다. 이번에는 GitHub Action을 사용하여 간단한 CI/CD 파이프라인을 설정하는 방법에 대해 알아보겠습니다.

 

GitHub Action 설정

GitHub Action을 사용하려면 먼저 .github/workflows 디렉토리를 만듭니다. 이 디렉토리는 GitHub Action을 저장하는 곳입니다. 그리고 다음과 같은 YAML 파일을 생성합니다.

name: CI/CD

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

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

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14.x'

      - name: Install dependencies
        run: npm install

      - name: Build
        run: npm run build

      - name: Test
        run: npm test

위 YAML 파일은 main 브랜치로 푸시하거나 풀 리퀘스트가 열렸을 때 실행되도록 설정합니다. build 작업은 Ubuntu 환경에서 실행되며, 다음과 같은 단계를 수행합니다.

• 코드 체크아웃
• Node.js 설정
• 의존성 설치
• 빌드
• 테스트
• 배포

위 YAML 파일은 빌드 및 테스트를 수행하지만, 배포는 아직 수행하지 않습니다. 배포는 deploy 작업을 추가하여 수행할 수 있습니다. 다음과 같이 YAML 파일을 수정합니다.

name: CI/CD

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

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

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14.x'

      - name: Install dependencies
        run: npm install

      - name: Build
        run: npm run build

      - name: Test
        run: npm test

  deploy:
    needs: build
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'

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

      - name: Deploy to AWS
        uses: easingthemes/ssh-deploy@v2.1.5
        with:
          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
          remote-username: ${{ secrets.REMOTE_USERNAME }}
          server-ip: ${{ secrets.SERVER_IP }}
          source: './dist'
          remote-directory: '/var/www/myapp'

위 YAML 파일은 deploy 작업을 추가하여 빌드 및 테스트 후에 배포를 수행합니다. 배포 작업은 build 작업이 성공적으로 완료된 후에만 실행되도록 설정됩니다. 또한, github.ref 값이 refs/heads/main 인 경우에만 배포 작업이 수행됩니다.

deploy 작업은 AWS에 배포되는 예제입니다. 이 작업은 easingthemes/ssh-deploy 액션을 사용하여 실행됩니다. 이 액션은 SSH를 사용하여 리모트 서버에 연결하고, 빌드된 앱을 리모트 서버의 /var/www/myapp 디렉토리에 배포합니다. 배포할 서버의 IP 주소, 사용자 이름, SSH 개인 키 등은 GitHub Secrets를 사용하여 설정할 수 있습니다.

 

GitHub Secrets 설정

GitHub Secrets는 암호화된 저장소로, 보안을 유지하기 위해 사용자가 지정한 값만 저장합니다. GitHub Secrets를 사용하면 YAML 파일에서 하드코딩하지 않고, 중요한 정보를 저장할 수 있습니다. 이번 예제에서는 SSH 개인 키, 리모트 사용자 이름 및 서버 IP 주소를 저장합니다.

 

GitHub Secrets를 설정하려면, 먼저 저장소 설정으로 이동하여 Secrets 탭을 클릭합니다. 그런 다음 New repository secret 버튼을 클릭하고, 암호화하려는 정보를 입력합니다.

 

실행 및 확인

이제 GitHub Action 설정이 완료되었으므로 코드를 변경하고 푸시하면, GitHub Action이 자동으로 빌드, 테스트 및 배포를 수행합니다. 이 작업을 확인하려면, 저장소의 Actions 탭으로 이동하여 GitHub Action 실행 로그를 볼 수 있습니다.

이상으로 GitHub Action을 사용하여 간단한 CI/CD 파이프라인을 설정하는 방법에 대해 알아보았습니다. GitHub Action을 사용하면 CI/CD 파이프라인을 간편하게 설정할 수 있으며, 코드 변경 사항이 발생할 때마다 자동으로 빌드, 테스트 및 배포를 수행할 수 있습니다.