GitHub Action으로 AWS S3에 배포 자동화

📍GitHub Action 이란?

---

GitHub Actions는 Github가 공식적으로 제공하는 빌드, 테스트 및 배포 파이프라인을 자동화할 수 있는 CI/CD 플랫폼이다.

레포지토리에서 Pull Request 나 push 같은 이벤트를 트리거로 GitHub 작업 워크플로(Workflow)를 구성할 수 있다. 워크플로는 하나 이상의 작업이 실행되는 자동화 프로세스로, 각 작업은 자체 가상 머신 또는 컨테이너 내부에서 실행되며 테스트, 배포 등 기능에 따라 여러 개의 워크플로도 만들 수 있다.

생성된 워크플로는 .github/workflows 디렉터리에 yml (혹은. yaml ) 파일로 저장된다.

YAML 파일 위치

 

📍YAML 이란?

---

Yet Another Markup Language의 약자로, 사람이 읽을 수 있는 데이터 직렬화 언어를 의미한다. 다른 프로그래밍 언어와 함께 사용할 수도 있는 유연성과 접근성으로 인해 자동화 프로세스를 생성하는 데에도 사용된다.

JSON의 상위 호환

• JSON 파일과 다르게 주석을 작성가능해서 커뮤니케이션 원활
• {}가 없어서 스코프 압박에서 벗어남
• ""(큰따옴표)가 없이 문자열 작성이 가능해서 한눈에 들어옴
• JSON으로 변환하고 그 반대로도 가능

YAML문법: https://subicura.com/k8s/prepare/yaml.html

 

📍클라이언트 배포 실습

---

클라이언트 배포는 간단하게 3가지 단계로 나뉜다.

1. Source: Github reference 브랜치에 코드가 커밋
2. Build: github acitons의 YAML 파일에 적힌 명령어를 토대로 Webpack을 이용해 빌드
3. Deploy: github acitons의 YAML 파일에 적힌 명령어를 토대로 s3로 빌드 결과를 업로드

위 단계대로 워크플로를 구성해보자.

# .github/workflows/client.yml
name: client
on:
  push:
    branches:
      - reference # 워크플로를 사용할 브랜치
jobs:
  build:
    runs-on: ubuntu-20.04
    steps:
    	# Source 단계
      - name: Checkout source code.
        uses: actions/checkout@v2
      - name: Install dependencies
        run: npm install
        working-directory: ./my-agora-states-client
        
        # Build 단계
      - name: Build
        run: npm run build
        working-directory: ./my-agora-states-client
      - name: SHOW AWS CLI VERSION
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_KEY }}
          AWS_EC2_METADATA_DISABLED: true
        run: |
          aws --version
        
        # Deploy 단계: Bucket에 업로드
      - name: Sync Bucket
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_KEY }}
          AWS_EC2_METADATA_DISABLED: true
        run: | # AWS CLI 명령어 사용
          aws s3 sync \
            --region ap-northeast-2 \
            build s3://fe-53-kihyeoon \
            --delete
        working-directory: ./my-agora-states-client

AWS CLI 명령어: https://docs.aws.amazon.com/ko_kr/cli/latest/userguide/cli-services-s3-commands.html#using-s3-commands-prereqs

AWS ID와 KEY는 깃헙 action secret에 등록해서 외부에 노출되지 않도록 관리해야 한다. 만약에 설정 파일 코드에 키가 노출된 상태로 S3에 업로드하면 AWS에서 자동으로 버켓을 정지시킬 수도 있다.