[CI/CD] GitHub Actions를 이용한 빌드 및 배포 자동화

🌊 배포 흐름

 

🧐 GitHub Actions란

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

GitHub Actions 사용 시 repository에서 이벤트(PR 혹은 push)가 발생할 때 특정 작업을 실행해 개발 및 배포 프로세스를 자동화할 수 있다.

 

• CI/CD 워크플로우
  push, PR(Pull Request) 생성, Issue 등의 이벤트에 대해 지정된 작업을 실행하여 지속적으로 통합하고 배포한다.
  이를 통해 빌드, 테스트, 코드 리뷰, 배포 등의 과정을 자동화할 수 있다.
• 테스트 자동화
  코드 변경 사항을 테스트하여 품질 관리를 강화하고, 테스트 결과를 보고 및 분석하여 문제를 식별한다.
• 워크플로우 자동화
  프로젝트 관리, 버전 관리, 알림 및 통지, 문서 생성 등과 같은 작업을 자동화하여 효율성을 향상시킨다.

GitHub Actions는 YAML 기반의 workflow 파일을 통해 작업 단계, 환경 변수, 트리거 조건 등을 설정할 수 있으며, 필요한 도구 및 서비스와의 통합을 지원한다.

 

🧐 Code Deploy란

AWS가 제공하는 애플리케이션 배포 자동화 서비스

CICD - Codedeploy란? (Codedeploy를 이용한 자동배포(CD) 환경 구축하기)

Code Deploy에 관한 정보와 설정은 해당 링크를 참조하면 될 것 같다.

 

---

👍 사전 준비

1. Pulbic Repository여야 무료로 사용할 수 있다.
2. AWS CLI와 Code Deploy Agent가 EC2에 설치되어 있어야 한다.
3. S3 버킷이 생성되어 있어야 한다.

🌱 EC2에 AWS CLI 설치 (❗️Ubuntu 기준❗️)

1. AWS CLI를 설치할 때 필요한 패키지 설치

$ sudo apt install curl unzip

 

2. curl을 통해 awscliv2.zip 파일을 다운받아 압축 풀기

# awscliv2.zip 파일 다운
$ curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"

# 압축 풀기
$ unzip awscliv2.zip

 

3. AWS CLI 설치를 위한 스크립트 실행

$ sudo ./aws/install
You can now run: /usr/local/bin/aws --version

$ aws --version
aws-cli/2.13.0 Python/3.11.4 Linux/5.19.0-1026-aws exe/x86_64.ubuntu.22 prompt/off

 4. 완료~

 

🌱 EC2에 AWS Code Deploy 설치 (❗️Ubuntu 기준❗️)

나의 경우 우분투라 공식 문서의 사용 설명서를 참고해 EC2에 Code Deploy를 설치해 주었다.

$ sudo apt update

$ sudo apt install ruby-full

$ sudo apt install wget

$ cd /home/ubuntu

$ wget https://aws-codedeploy-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/latest/install

$ chmod +x ./install

$ sudo ./install auto

 

✌️ 리소스 설정

1️⃣ Github Actions 생성

프로젝트 레포지토리 -> ▶️ Actions로 이동해 workflow 설정한다.

 

set up a workflow yourself 를 클릭하면 빈 yml 설정파일로 workflow를 설정할 수 있고

Suggested for this repository에서 추천 workflow 구성을 선택할 수 있다.

 

2️⃣ Github Action 설정 파일(Workflow) 만들기

우선 Java with Gradle의 workflow 구성을 클릭했더니 아래 workflow가 추천되었다.

name: Java CI with Gradle

on:
  push:
    branches: [ "develop" ]
  pull_request:
    branches: [ "develop" ]

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up JDK 11
      uses: actions/setup-java@v3
      with:
        java-version: '11'
        distribution: 'temurin'
    - name: Build with Gradle
      uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
      with:
        arguments: build

 

❗️GitHub Secret 등록

GitHub Secret은 API 키나 passsword 같은 보안 이슈가 있는 데이터를 관리해 주는 역할을 한다.
secrets에 원하는 값 입력 시 actions의 workflow가 실행될 때 해당 secrets에 접근이 가능하다.
이때 동적으로 secrets의 데이터를 취합해 .env 파일을 생성한다.

GitHub Actions에 프로젝트 빌드 결과물을 AWS의 S3 버킷에 전송하는 workflow를 실행하는 과정에서 AWS의 Access Key와 Secret Key가 필요하지만 이를 공개할 경우 보안 이슈가 발생할 수 있다. 따라서 GitHub Secret 을 등록해 보안이 필요한 값들을 저장하여 사용한다.

프로젝트 레포지토리 > Settings > Secrets and variables > Actions 로  이동해 New repository secret을 클릭한다.

 

Access key를 발급받는 과정은 해당 블로그를 참고하면 될 것 같다. 

[AWS] AWS Access key 발급받고 aws-cli 사용하기

 

Name에는 AWS_ACCESS_KEY을, Secret에는 값을 입력해 저장하면 workflow에서 ${{secrets.AWS_ACCESS_KEY}} 형태로 접근이 가능하다.

 

따라서 workflow 파일에 AWS Access Key와 Secret Access Key를 추가해 AWS 권한을 확인한다.

# Access Key와 Secret Key를 통해 권한을 확인한다.
- name: AWS Configure credentials
  uses: aws-actions/configure-aws-credentials@v1
  with:
    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
    aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
    aws-region: ap-northeast-2

 

❗️자주 사용하는 값들은 env로 지정

env:
  PROJECT_NAME: 프로젝트 이름
  S3_BUCKET_NAME: Amazon S3 Bucket 이름
  CODE_DEPLOY_APPLICATION_NAME: Amazon Code Deploy 어플리케이션 이름
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: Code Deploy 그룹 이름

 

❗️빌드 결과물을 S3 버킷에 전송

- 우선 gradlew 파일에 실행 권한을 추가해 준 후 Gradle을 사용해 컨트롤러 테스트를 실행한다.

(나의 경우 API 문서로 REST Docs를 사용하기 때문에 컨트롤러 테스트가 실행되어야 API 문서가 생성된다.)

- name: Grant execute permission for gradlew
  run: chmod +x ./gradlew

- name: Controller Test with Gradle
  run: ./gradlew test --tests "{컨트롤러 테스트 경로}"

 

- Gradle을 사용해 테스트를 제외하고 프로젝트를 빌드한 후 프로젝트 파일을 압축하여 zip 파일을 생성한다.

- name: Build with Gradle
  run: ./gradlew build -x test

- name: Make zip file
  run: zip -qq -r ./$GITHUB_SHA.zip .
  shell: bash

 

• zip
  파일을 압축하는 명령어
• -qq
  "Quiet" 모드. 압축 과정 중 메시지 최소화
• -r
  "Recursive" 모드. 디렉토리를 재귀적으로 탐색해 하위 디렉토리와 파일 모두 압축
• ./$GITHUB_SHA.zip
  압축된 결과 파일의 이름. '$GITHUB_SHA' 는 GitHub에서 제공하는 현재 커밋의 고유 식별자이기 때문에 각 커밋별로 고유한 압축 파일 이름 생성 가능
• .
  압축 대상. 여기서는 현재 디렉토리의 모든 파일과 하위 디렉토리를 포함하여 압축하라는 의미

 

- 빌드된 프로젝트 파일을 S3 버킷으로 복사

- name: Upload to S3
  run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://${{ env.S3_BUCKET_NAME }}/${{ env.PROJECT_NAME }}/$GITHUB_SHA.zip

• --region ap-northeast-2
  업로드할 S3 버킷의 AWS region
• ./$GITHUB_SHA.zip
  로컬에 생성된 압축 파일 경로
• s3://${{ env.S3_BUCKET_NAME }}/${{ env.PROJECT_NAME }}/$GITHUB_SHA.zip
  S3 버킷의 경로

 

- AWS CodeDeploy를 사용하여 배포

- name: Deploy with AWS codeDeploy
  run: aws deploy create-deployment
    --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }}
    --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }}
    --deployment-config-name CodeDeployDefault.AllAtOnce
    --s3-location bucket=$S3_BUCKET_NAME,key=$PROJECT_NAME/$GITHUB_SHA.zip,bundleType=zip

• aws deploy create-deployment
  새로운 배포 생성
• --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }}
  배포할 AWS CodeDeploy 어플리케이션 이름 지정
• --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }}
  배포할 AWS CodeDeploy 배포 그룹 이름 지정
• --deployment-config-name CodeDeployDefault.AllAtOnce
  배포 구성 이름(CodeDeploy Application 생성 시 정한 배포 구성)
• --s3-location bucket=$S3_BUCKET_NAME,key=$PROJECT_NAME/$GITHUB_SHA.zip,bundleType=zip
  S3에서 배포할 배포 파일의 위치 지정

 

✅ 완성된 풀 스크립트

name: Deploy to Amazon EC2

on:
  push:
    branches: [ "develop" ]

permissions:
  contents: read

env:
  PROJECT_NAME: 프로젝트 이름
  S3_BUCKET_NAME: Amazon S3 Bucket 이름
  CODE_DEPLOY_APPLICATION_NAME: Amazon Code Deploy 어플리케이션 이름
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: Code Deploy 그룹 이름

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3
    
    - name: Set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'
        
    - name: Grant execute permission for gradlew
      run: chmod +x ./gradlew
    
    - name: Controller Test with Gradle
      run: ./gradlew test --tests "컨트롤러 테스트 경로"
        
    - name: Build with Gradle
      run: ./gradlew build -x test

    - name: Make zip file
      run: zip -qq -r ./$GITHUB_SHA.zip .
      shell: bash
        
    - name: AWS Configure credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
        aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
        aws-region: ap-northeast-2

    - name: Upload to S3
      run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://${{ env.S3_BUCKET_NAME }}/${{ env.PROJECT_NAME }}/$GITHUB_SHA.zip
      
    - name: Deploy with AWS codeDeploy
      run: aws deploy create-deployment
        --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }}
        --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }}
        --deployment-config-name CodeDeployDefault.AllAtOnce
        --s3-location bucket=$S3_BUCKET_NAME,key=$PROJECT_NAME/$GITHUB_SHA.zip,bundleType=zip

 

yml 변경 사항을 commit후 push 하면 gradle.yml 파일이 생성됨과 동시에 workflow에 작성된 트리거를 통해 S3 버킷에 압축 파일이 전송되었음을 확인할 수 있다.

 

Actions 탭에서 생성된 워크플로의 각 단계별 진행 상황을 확인할 수 있으며, 진행/성공/실패 여부는 repository에서 최근 commit 내역과 함께 표시된다.

 

https://docs.aws.amazon.com/ko_kr/codedeploy/latest/userguide/codedeploy-agent-operations-install-ubuntu.html

https://jinmay.github.io/2020/05/13/aws/how-to-install-code-deploy-agent-ubuntu/