Github Actions

🎬Intro

github actions에 대해 알아보겠습니다.

✅ Github actions

github에서 제공하는 자동화 도구입니다. github의 특정 브랜치로 push나 pr이 발생할때 개발자가 정의해놓은 작업을 자동으로 실행할 수 있는 기능입니다. 해당 작업들은 github가 제공하는 가상환경(클라우드 pc)에서 진행됩니다.

1. workflow

• 특정 이벤트(push 혹은 pr)가 발생하면 실행되는 작업입니다.
• .github/workflows 폴더 내의 YAML 파일로 정의됩니다.

2. Job

• workflow 내에서 실행되는 작업 단위입니다.
• 여러 job으로 나눌 수 있으며, 각 job은 서로 독립된 가상환경에서 실행됩니다.

3. Step

• Job 안에서 실행되는 작업의 세부 단계입니다.
• 각 Step은 스크립트로 직접 작업을 정의할 수 있고 다른 개발자가 정의해 놓은 액션을 실행할 수 있습니다.

4. Action

• 다른 개발자가 정의해 놓은 작업 입니다. 즉, 모듈이라고 이해하시면 됩니다.

📝 예시

현재 사이드프로젝트에서 사용하고 있는 CI/CD 스크립트를 예로 들어보겠습니다.

Jobs

build

1. main 또는 develop 브랜치로 pr이 발생
2. 애플리케이션을 실행하기 위해 애플리케이션이 위치한 github 레포지토리로 체크아웃
3. JDK 17 설치
4. gradlew 파일을 실행하기 위해 권한부여
5. gradle을 통해 빌드
6. 도커허브 로그인
7. pr에 따른 도커이미지 이름 설정 develop -> 개발, main -> 운영
8. 도커 빌드 & 도커허브에 푸시

deploy

1. build job이 성공했을 경우에 실행
2. pr에 따른 배포 타겟 설정 develop -> 개발, main -> 운영
3. EC2 원격 접속 및 도커컴포즈를 이용한 빌드

CI/CD Script

# 워크플로우 이름 설정
name: Java CI/CD with Gradle

# 워크플로우 실행 조건
# main, develop 브랜치에 pr이 발생했을때 실행
on:
  pull_request:
    branches: [ main, develop ]

# 애플리케이션 실행을 위해 레포지토리를 읽을 수 있는 권한 부여
permissions:
  contents: read

# 작업 정의
# 1. build
# 2. deploy
jobs:
  # 1. build
  build:
    runs-on: ubuntu-22.04 # 우분투에서 실행
    # 작업 스텝
    steps:
      # 애플리케이션이 올라가 있는 레포지토리로 체크아웃
      # 다른 개발자가 정의해놓은 액션 이용
      - name: 레포지토리 체크아웃
        uses: actions/checkout@v4
        with:
          token: $ # 서브모듈 접근을 위한 토큰
          submodules: true # 서브모듈들도 함께 가져옴
      
      # 애플리케이션 빌드을 위한 java 설치
      # 다른 개발자가 정의해놓은 액션 이용
      - name: JDK 17 설치
        uses: actions/setup-java@v4
        with:
          java-version: '17' # 자바 버전
          distribution: 'temurin' # 제공자
      
      # gradlew 실행을 위한 권한 부여
      - name: gradlew 권한 부여
        run: chmod +x gradlew # 실행권한부여
      
      # gradle을 이용한 빌드
      - name: Gradle 통해 빌드
        run: ./gradlew clean build # 빌드
      
      # 도커 허브 로그인
      # 다른 개발자가 정의해놓은 액션 이용
      - name: DockerHub 로그인
        uses: docker/login-action@v3
        with:
          username: $ # 도커 로그인을 위한 유저네임
          password: $ # 도커 로그인을 위한 토큰
      
      # pr에 따른 도커 이미지 이름 및 환경 설정
      # develop -> 개발, main -> 운영
      - name: Docker 이미지 이름 및 환경 설정
        run: |
          if [[ "$" == "main" ]]; then
            echo "IMAGE_NAME=fashion-forecast-prod" >> $GITHUB_ENV
          elif [[ "$" == "develop" ]]; then
            echo "IMAGE_NAME=fashion-forecast-dev" >> $GITHUB_ENV
          fi
      
      # EC2에서 사용하기위해 도커 빌드 & 허브에 푸시
      # 다른 개발자가 정의해놓은 액션 이용
      - name: 도커 빌드 & 푸시
        uses: docker/build-push-action@v6
        with:
          context: . # 도커가 빌드를 수행할 디렉토리 경로 
          file: ./Dockerfile # 루트 디렉토리에 있는 도커파일
          push: true # 이미지 빌드 후 레지스트리에 푸시
          platforms: linux/amd64 # 빌드할 플랫폼 지정 (EC2와 일치)
          tags: $/$:latest # 태그 지정
  
  # 2. deploy
  deploy:
    # needs 조건으로 build가 성공했을때만 실행
    needs: build
    runs-on: ubuntu-latest # 우분투에서 실행
    steps:
      # pr에 따른 배포 타겟 설정, 도커 컴포즈 파일의 이름을 설정하기 위함
      # develop -> 개발, main -> 운영
      - name: 배포 타겟 설정
        run: |
          if [[ "$" == "main" ]]; then
            echo "DEPLOY_ENV=prod" >> $GITHUB_ENV
          elif [[ "$" == "develop" ]]; then
            echo "DEPLOY_ENV=dev" >> $GITHUB_ENV
          fi
      
      # EC2 원격 접속 및 도커컴포즈를 이용한 빌드
      # 다른 개발자가 정의해놓은 액션 이용
      - name: EC2 원격 접속 및 Docker compose
        uses: appleboy/ssh-action@master
        with:
          username: $ # EC2 유저네임
          host: $ # EC2 호스트
          key: $ # EC2 키(pem키)
          script_stop: true # 아래 스크립트가 실패했을때 스크립트를 즉시 중단
          # 도커 이미지 당겨오기 
          # develop -> fashion-forecast-dev:latest, main -> fashion-forecast-prod:latest
          # 도커 컴포즈를 이용한 도커 이미지 다운 & 빌드(-f는 실행전 확인 메세지를 생략하고 강제로 실행, 빌드는 -d 옵션으로 백그라운드에서 실행)
          # develop -> docker-compose-dev.yml, main -> docker-compose-prod.yml
          # 디스크 관리를 위한 사용하지 않는 불필요한 이미지 삭제
          script: |
            sudo docker pull $/fashion-forecast-$:latest
            sudo docker compose -f docker-compose-$.yml down
            sudo docker compose -f docker-compose-$.yml up -d
            sudo docker image prune -f